Repository: commons-compress Updated Branches: refs/heads/master b8101b95c -> f874b8c25
javadocs for java8 Project: http://git-wip-us.apache.org/repos/asf/commons-compress/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-compress/commit/dbb9d658 Tree: http://git-wip-us.apache.org/repos/asf/commons-compress/tree/dbb9d658 Diff: http://git-wip-us.apache.org/repos/asf/commons-compress/diff/dbb9d658 Branch: refs/heads/master Commit: dbb9d658ca5e76566757dfc28a1d4c555345dcfe Parents: b8101b9 Author: Stefan Bodewig <[email protected]> Authored: Mon Jan 9 18:17:36 2017 +0100 Committer: Stefan Bodewig <[email protected]> Committed: Mon Jan 9 18:17:36 2017 +0100 ---------------------------------------------------------------------- .../compress/compressors/lz77support/LZ77Compressor.java | 5 +++++ .../commons/compress/compressors/lz77support/Parameters.java | 5 +++++ src/main/java/org/apache/commons/compress/utils/Iterators.java | 3 +++ src/main/java/org/apache/commons/compress/utils/Lists.java | 2 ++ src/main/java/org/apache/commons/compress/utils/Sets.java | 1 + 5 files changed, 16 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-compress/blob/dbb9d658/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java b/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java index 1eb5cfe..d7b0d8f 100644 --- a/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java +++ b/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java @@ -108,18 +108,21 @@ public class LZ77Compressor { * * <p>This returns a life view of the actual data in order to * avoid copying, modify the array at your own risk.</p> + * @return the data */ public byte[] getData() { return data; } /** * Offset into data where the literal block starts. + * @return the offset */ public int getOffset() { return offset; } /** * Length of literal block. + * @return the length */ public int getLength() { return length; @@ -141,12 +144,14 @@ public class LZ77Compressor { } /** * Provides the offset of the match. + * @return the offset */ public int getOffset() { return offset; } /** * Provides the length of the match. + * @return the length */ public int getLength() { return length; http://git-wip-us.apache.org/repos/asf/commons-compress/blob/dbb9d658/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java b/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java index 1149302..012f844 100644 --- a/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java +++ b/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java @@ -80,30 +80,35 @@ public final class Parameters { /** * Gets the size of the sliding window - this determines the * maximum offset a back-reference can take. + * @return the size of the sliding window */ public int getWindowSize() { return windowSize; } /** * Gets the minimal length of a match found. + * @return the minimal length of a match found */ public int getMinMatchLength() { return minMatchLength; } /** * Gets the maximal length of a match found. + * @return the maximal length of a match found */ public int getMaxMatchLength() { return maxMatchLength; } /** * Gets the maximal offset of a match found. + * @return the maximal offset of a match found */ public int getMaxOffset() { return maxOffset; } /** * Gets the maximal length of a literal block. + * @return the maximal length of a literal block */ public int getMaxLiteralLength() { return maxLiteralLength; http://git-wip-us.apache.org/repos/asf/commons-compress/blob/dbb9d658/src/main/java/org/apache/commons/compress/utils/Iterators.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/compress/utils/Iterators.java b/src/main/java/org/apache/commons/compress/utils/Iterators.java index 89c15c5..eb57643 100644 --- a/src/main/java/org/apache/commons/compress/utils/Iterators.java +++ b/src/main/java/org/apache/commons/compress/utils/Iterators.java @@ -39,6 +39,9 @@ public class Iterators { * {@code hasNext()} method returns {@code false}. * </p> * + * @param <T> type of the elements contained inside the collection + * @param collection target collection + * @param iterator source * @return {@code true} if the target {@code collection} was modified as a * result of this operation */ http://git-wip-us.apache.org/repos/asf/commons-compress/blob/dbb9d658/src/main/java/org/apache/commons/compress/utils/Lists.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/compress/utils/Lists.java b/src/main/java/org/apache/commons/compress/utils/Lists.java index 83709af..9916bd3 100644 --- a/src/main/java/org/apache/commons/compress/utils/Lists.java +++ b/src/main/java/org/apache/commons/compress/utils/Lists.java @@ -32,6 +32,7 @@ public class Lists { /** * Creates a new {@link ArrayList}. * + * @param <E> type of elements contained in new list * @return a new {@link ArrayList} */ public static <E> ArrayList<E> newArrayList() { @@ -44,6 +45,7 @@ public class Lists { * * @param iterator * the source iterator + * @param <E> type of elements contained in new list * @return a new {@link ArrayList} */ public static <E> ArrayList<E> newArrayList(final Iterator<? extends E> iterator) { http://git-wip-us.apache.org/repos/asf/commons-compress/blob/dbb9d658/src/main/java/org/apache/commons/compress/utils/Sets.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/compress/utils/Sets.java b/src/main/java/org/apache/commons/compress/utils/Sets.java index b8b8578..556a023 100644 --- a/src/main/java/org/apache/commons/compress/utils/Sets.java +++ b/src/main/java/org/apache/commons/compress/utils/Sets.java @@ -38,6 +38,7 @@ public class Sets { * * @param elements * the elements to fill the new set + * @param <E> type of elements contained in new set * @return A new HasSet */ public static <E> HashSet<E> newHashSet(@SuppressWarnings("unchecked") E... elements) {
