You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2020/04/11 20:25:26 UTC
[maven-indexer] 03/05: [MINDEXER-124] Add javadoc
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch MINDEXER-124
in repository https://gitbox.apache.org/repos/asf/maven-indexer.git
commit 2ba725ee8be71cc162b268bcb22af567df1ead66
Author: sixcorners <si...@gmail.com>
AuthorDate: Sun Feb 2 19:57:35 2020 -0600
[MINDEXER-124] Add javadoc
---
.../org/apache/maven/index/reader/resource/BufferedResource.java | 3 +++
.../apache/maven/index/reader/resource/BufferedResourceHandler.java | 5 +++++
.../maven/index/reader/resource/BufferedWritableResource.java | 5 +++++
.../index/reader/resource/BufferedWritableResourceHandler.java | 6 ++++++
.../apache/maven/index/reader/resource/PathWritableResource.java | 3 +++
.../maven/index/reader/resource/PathWritableResourceHandler.java | 3 +++
.../org/apache/maven/index/reader/resource/UriResourceHandler.java | 3 +++
.../java/org/apache/maven/index/reader/resource/UrlResource.java | 3 +++
8 files changed, 31 insertions(+)
diff --git a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedResource.java b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedResource.java
index c7c646a..5312833 100644
--- a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedResource.java
+++ b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedResource.java
@@ -5,6 +5,9 @@ import java.io.IOException;
import java.io.InputStream;
import org.apache.maven.index.reader.ResourceHandler.Resource;
+/**
+ * Wraps {@link Resource}s so that they return {@link BufferedInputStream}s.
+ */
public class BufferedResource implements Resource {
private final Resource resource;
diff --git a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedResourceHandler.java b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedResourceHandler.java
index 4ffc65f..f3269dc 100644
--- a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedResourceHandler.java
+++ b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedResourceHandler.java
@@ -1,8 +1,13 @@
package org.apache.maven.index.reader.resource;
+import java.io.BufferedInputStream;
import java.io.IOException;
import org.apache.maven.index.reader.ResourceHandler;
+/**
+ * Wraps {@link ResourceHandler}s so that they return {@link Resource}s that return {@link
+ * BufferedInputStream}s.
+ */
public class BufferedResourceHandler implements ResourceHandler {
private final ResourceHandler resourceHandler;
diff --git a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedWritableResource.java b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedWritableResource.java
index 176ab4f..b95f8c6 100644
--- a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedWritableResource.java
+++ b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedWritableResource.java
@@ -1,10 +1,15 @@
package org.apache.maven.index.reader.resource;
+import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import org.apache.maven.index.reader.WritableResourceHandler.WritableResource;
+/**
+ * Wraps {@link WritableResource}s so that they return {@link BufferedInputStream}s and {@link
+ * BufferedOutputStream}s.
+ */
public class BufferedWritableResource extends BufferedResource implements WritableResource {
private final WritableResource resource;
diff --git a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedWritableResourceHandler.java b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedWritableResourceHandler.java
index f05faa3..67ff338 100644
--- a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedWritableResourceHandler.java
+++ b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/BufferedWritableResourceHandler.java
@@ -1,8 +1,14 @@
package org.apache.maven.index.reader.resource;
+import java.io.BufferedInputStream;
+import java.io.BufferedOutputStream;
import java.io.IOException;
import org.apache.maven.index.reader.WritableResourceHandler;
+/**
+ * Wraps {@link WritableResourceHandler}s so that they return {@link WritableResource}s that return
+ * {@link BufferedInputStream}s and {@link BufferedOutputStream}s.
+ */
public class BufferedWritableResourceHandler implements WritableResourceHandler {
private final WritableResourceHandler writableResourceHandler;
diff --git a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/PathWritableResource.java b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/PathWritableResource.java
index 58ed981..21659ac 100644
--- a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/PathWritableResource.java
+++ b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/PathWritableResource.java
@@ -8,6 +8,9 @@ import java.nio.file.NoSuchFileException;
import java.nio.file.Path;
import org.apache.maven.index.reader.WritableResourceHandler.WritableResource;
+/**
+ * A {@link WritableResource} that represents a {@link Path}.
+ */
public class PathWritableResource implements WritableResource {
private final Path path;
diff --git a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/PathWritableResourceHandler.java b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/PathWritableResourceHandler.java
index d47b78a..e98b13b 100644
--- a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/PathWritableResourceHandler.java
+++ b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/PathWritableResourceHandler.java
@@ -4,6 +4,9 @@ import java.io.IOException;
import java.nio.file.Path;
import org.apache.maven.index.reader.WritableResourceHandler;
+/**
+ * A {@link WritableResourceHandler} that represents the base of a {@link Path} hierarchy.
+ */
public class PathWritableResourceHandler implements WritableResourceHandler {
private final Path path;
diff --git a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/UriResourceHandler.java b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/UriResourceHandler.java
index 6c50c66..cce1b00 100644
--- a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/UriResourceHandler.java
+++ b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/UriResourceHandler.java
@@ -4,6 +4,9 @@ import java.io.IOException;
import java.net.URI;
import org.apache.maven.index.reader.ResourceHandler;
+/**
+ * A {@link ResourceHandler} that represents the base of a {@link URI} hierarchy.
+ */
public class UriResourceHandler implements ResourceHandler {
private final URI uri;
diff --git a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/UrlResource.java b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/UrlResource.java
index f302578..584ef40 100644
--- a/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/UrlResource.java
+++ b/indexer-reader/src/main/java/org/apache/maven/index/reader/resource/UrlResource.java
@@ -6,6 +6,9 @@ import java.io.InputStream;
import java.net.URL;
import org.apache.maven.index.reader.ResourceHandler.Resource;
+/**
+ * A {@link Resource} that represents a {@link URL}.
+ */
public class UrlResource implements Resource {
private final URL url;