Browse Source

Address some Javadoc issues

master
Matt Benson 3 years ago
parent
commit
10316f910f
2 changed files with 17 additions and 11 deletions
  1. +13
    -9
      src/main/org/apache/tools/zip/ZipEntry.java
  2. +4
    -2
      src/main/org/apache/tools/zip/ZipOutputStream.java

+ 13
- 9
src/main/org/apache/tools/zip/ZipEntry.java View File

@@ -169,7 +169,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
} }


/** /**
* Overwrite clone.
* Override clone.
* *
* @return a cloned copy of this ZipEntry * @return a cloned copy of this ZipEntry
* @since 1.1 * @since 1.1
@@ -486,7 +486,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
* Looks up an extra field by its header id. * Looks up an extra field by its header id.
* *
* @param type ZipShort * @param type ZipShort
* @return null if no such field exists.
* @return {@code null} if no such field exists.
*/ */
public ZipExtraField getExtraField(final ZipShort type) { public ZipExtraField getExtraField(final ZipShort type) {
if (extraFields != null) { if (extraFields != null) {
@@ -502,7 +502,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/** /**
* Looks up extra field data that couldn't be parsed correctly. * Looks up extra field data that couldn't be parsed correctly.
* *
* @return null if no such field exists.
* @return {@code null} if no such field exists.
*/ */
public UnparseableExtraFieldData getUnparseableExtraFieldData() { public UnparseableExtraFieldData getUnparseableExtraFieldData() {
return unparseableExtra; return unparseableExtra;
@@ -546,7 +546,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/** /**
* Sets the central directory part of extra fields. * Sets the central directory part of extra fields.
* *
* @param b boolean
* @param b {@code boolean}
*/ */
public void setCentralDirectoryExtra(final byte[] b) { public void setCentralDirectoryExtra(final byte[] b) {
try { try {
@@ -587,7 +587,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
* *
* @param size the size to use * @param size the size to use
* @deprecated since 1.7. * @deprecated since 1.7.
* Use setCompressedSize directly.
* Use {@link #setCompressedSize(long)} directly.
* @since 1.2 * @since 1.2
*/ */
@Deprecated @Deprecated
@@ -609,7 +609,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/** /**
* Is this entry a directory? * Is this entry a directory?
* *
* @return true if the entry is a directory
* @return {@code true} if the entry is a directory
* @since 1.10 * @since 1.10
*/ */
@Override @Override
@@ -759,13 +759,17 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
} }
} }


/** {@inheritDoc} */
/**
* Get last modified time as {@link Date}.
*
* @return {@link Date}
*/
public Date getLastModifiedDate() { public Date getLastModifiedDate() {
return new Date(getTime()); return new Date(getTime());
} }


/* (non-Javadoc)
* @see java.lang.Object#equals(java.lang.Object)
/**
* {@inheritDoc}
*/ */
@Override @Override
public boolean equals(final Object obj) { public boolean equals(final Object obj) {


+ 4
- 2
src/main/org/apache/tools/zip/ZipOutputStream.java View File

@@ -495,7 +495,8 @@ public class ZipOutputStream extends FilterOutputStream {
} }


/** /**
* {@inheritDoc}
* Finish writing the archive.
*
* @throws Zip64RequiredException if the archive's size exceeds 4 * @throws Zip64RequiredException if the archive's size exceeds 4
* GByte or there are more than 65535 entries inside the archive * GByte or there are more than 65535 entries inside the archive
* and {@link #setUseZip64} is {@link Zip64Mode#Never}. * and {@link #setUseZip64} is {@link Zip64Mode#Never}.
@@ -728,7 +729,8 @@ public class ZipOutputStream extends FilterOutputStream {
} }


/** /**
* {@inheritDoc}
* Put the specified entry into the archive.
*
* @throws Zip64RequiredException if the entry's uncompressed or * @throws Zip64RequiredException if the entry's uncompressed or
* compressed size is known to exceed 4 GByte and {@link #setUseZip64} * compressed size is known to exceed 4 GByte and {@link #setUseZip64}
* is {@link Zip64Mode#Never}. * is {@link Zip64Mode#Never}.


Loading…
Cancel
Save