FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Javadoc · apache/commons-compress@6cb7da1 · GitHub

/ commons-compress Public

Commit 6cb7da1

Browse files
garydgregory
committed
Javadoc
1 parent 563c9d2 commit 6cb7da1

7 files changed

Lines changed: 31 additions & 35 deletions

File tree

‎src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ private long estimateSize(final PackingFile packingFile) {
271271
/**
272272
* Packs the archive.
273273
*
274-
* @throws Pack200Exception TODO
274+
* @throws Pack200Exception If a Pack200 semantic error occurs.
275275
* @throws IOException If an I/O error occurs.
276276
*/
277277
public void pack() throws Pack200Exception, IOException {

‎src/main/java/org/apache/commons/compress/harmony/pack200/BandSet.java‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ protected int[] cpEntryOrNullListToArray(final List<? extends ConstantPoolEntry>
353353
* @param ints the band
354354
* @param defaultCodec the default Codec
355355
* @return the encoded band
356-
* @throws Pack200Exception TODO
356+
* @throws Pack200Exception If a Pack200 semantic error occurs.
357357
*/
358358
public byte[] encodeBandInt(final String name, final int[] ints, final BHSDCodec defaultCodec) throws Pack200Exception {
359359
byte[] encodedBand = null;
@@ -433,7 +433,7 @@ public byte[] encodeBandInt(final String name, final int[] ints, final BHSDCodec
433433
* @param hiCodec Codec for the high 32-bits band
434434
* @param haveHiFlags ignores the high band if true as all values would be zero
435435
* @return the encoded band
436-
* @throws Pack200Exception TODO
436+
* @throws Pack200Exception If a Pack200 semantic error occurs.
437437
*/
438438
protected byte[] encodeFlags(final String name, final long[] flags, final BHSDCodec loCodec, final BHSDCodec hiCodec, final boolean haveHiFlags)
439439
throws Pack200Exception {
@@ -490,24 +490,24 @@ protected byte[] encodeFlags(final String name, final long[][] flags, final BHSD
490490
}
491491

492492
/**
493-
* Encode a single value with the given Codec
493+
* Encodes a single value with the given Codec.
494494
*
495-
* @param value the value to encode
496-
* @param codec Codec to use
497-
* @return the encoded value
498-
* @throws Pack200Exception TODO
495+
* @param value the value to encode.
496+
* @param codec Codec to use.
497+
* @return the encoded value.
498+
* @throws Pack200Exception If a Pack200 semantic error occurs.
499499
*/
500500
public byte[] encodeScalar(final int value, final BHSDCodec codec) throws Pack200Exception {
501501
return codec.encode(value);
502502
}
503503

504504
/**
505-
* Encode a band without considering other Codecs
505+
* Encode a band without considering other Codecs.
506506
*
507-
* @param band the band
508-
* @param codec the Codec to use
509-
* @return the encoded band
510-
* @throws Pack200Exception TODO
507+
* @param band the band.
508+
* @param codec the Codec to use.
509+
* @return the encoded band.
510+
* @throws Pack200Exception If a Pack200 semantic error occurs.
511511
*/
512512
public byte[] encodeScalar(final int[] band, final BHSDCodec codec) throws Pack200Exception {
513513
return codec.encode(band);
@@ -706,11 +706,11 @@ protected long[] longListToArray(final List<Long> longList) {
706706
}
707707

708708
/**
709-
* Writes the packed set of bands to the given output stream
709+
* Writes the packed set of bands to the given output stream.
710710
*
711711
* @param out TODO
712712
* @throws IOException If an I/O error occurs.
713-
* @throws Pack200Exception TODO
713+
* @throws Pack200Exception If a Pack200 semantic error occurs.
714714
*/
715715
public abstract void pack(OutputStream out) throws IOException, Pack200Exception;
716716

‎src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -174,28 +174,28 @@ public int[] decodeInts(final int n, final InputStream in, final int firstValue)
174174
/**
175175
* Encodes a single value into a sequence of bytes. Note that this method can only be used for non-delta encodings.
176176
*
177-
* @param value the value to encode
178-
* @return the encoded bytes
179-
* @throws Pack200Exception TODO
177+
* @param value the value to encode.
178+
* @return the encoded bytes.
179+
* @throws Pack200Exception If a Pack200 semantic error occurs.
180180
*/
181181
public abstract byte[] encode(int value) throws Pack200Exception;
182182

183183
/**
184184
* Encodes a single value into a sequence of bytes.
185185
*
186-
* @param value the value to encode
187-
* @param last the previous value encoded (for delta encodings)
188-
* @return the encoded bytes
189-
* @throws Pack200Exception TODO
186+
* @param value the value to encode.
187+
* @param last the previous value encoded (for delta encodings).
188+
* @return the encoded bytes.
189+
* @throws Pack200Exception If a Pack200 semantic error occurs.
190190
*/
191191
public abstract byte[] encode(int value, int last) throws Pack200Exception;
192192

193193
/**
194-
* Encodes a sequence of integers into a byte array
194+
* Encodes a sequence of integers into a byte array.
195195
*
196-
* @param ints the values to encode
197-
* @return byte[] encoded bytes
198-
* @throws Pack200Exception if there is a problem encoding any of the values
196+
* @param ints the values to encode.
197+
* @return byte[] encoded bytes.
198+
* @throws Pack200Exception if there is a problem encoding any of the values.
199199
*/
200200
public byte[] encode(final int[] ints) throws Pack200Exception {
201201
int total = 0;

‎src/main/java/org/apache/commons/compress/harmony/pack200/Segment.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -562,10 +562,10 @@ public boolean lastConstantHadWideIndex() {
562562
* The main method on Segment. Reads in all the class files, packs them and then writes the packed segment out to the given OutputStream.
563563
*
564564
* @param segmentUnit TODO
565-
* @param out the OutputStream to write the packed Segment to
566-
* @param options packing options
565+
* @param out the OutputStream to write the packed Segment to.
566+
* @param options packing options.
567567
* @throws IOException If an I/O error occurs.
568-
* @throws Pack200Exception TODO
568+
* @throws Pack200Exception If a Pack200 semantic error occurs.
569569
*/
570570
public void pack(final SegmentUnit segmentUnit, final OutputStream out, final PackingOptions options) throws IOException, Pack200Exception {
571571
this.options = options;

‎src/main/java/org/apache/commons/compress/harmony/unpack200/ClassBands.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ private void parseClassAttrBands(final InputStream in) throws IOException, Pack2
533533
* @param in TODO
534534
* @param classAttrCalls TODO
535535
* @return the number of backwards callables.
536-
* @throws Pack200Exception TODO
536+
* @throws Pack200Exception If a Pack200 semantic error occurs.
537537
* @throws IOException If an I/O error occurs.
538538
*/
539539
private int parseClassMetadataBands(final InputStream in, final int[] classAttrCalls) throws Pack200Exception, IOException {

‎src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -686,7 +686,7 @@ private StringReader getStreamUpToMatchingBracket(final StringReader stream) thr
686686
* @param occurrenceCount TODO
687687
* @return Class file attributes as a List of {@link Attribute}.
688688
* @throws IOException If an I/O error occurs.
689-
* @throws Pack200Exception TODO
689+
* @throws Pack200Exception If a Pack200 semantic error occurs.
690690
*/
691691
public List<Attribute> parseAttributes(final InputStream in, final int occurrenceCount) throws IOException, Pack200Exception {
692692
for (final AttributeLayoutElement element : attributeLayoutElements) {

‎src/main/java/org/apache/commons/compress/utils/TimeUtils.java‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,6 @@ public final class TimeUtils {
5959
/**
6060
* Tests whether a FileTime can be safely represented in the standard Unix time.
6161
*
62-
* <p>
63-
* TODO ? If the FileTime is null, this method always returns true.
64-
* </p>
65-
*
6662
* @param time the FileTime to evaluate, can be null.
6763
* @return true if the time exceeds the minimum or maximum Unix time, false otherwise.
6864
* @deprecated use {@link FileTimes#isUnixTime(FileTime)}

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL