You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by gi...@apache.org on 2017/12/10 06:16:17 UTC
[2/8] ant git commit: Let’s use doclint
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/mail/MailMessage.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/mail/MailMessage.java b/src/main/org/apache/tools/mail/MailMessage.java
index 4dc25dc..a7f6824 100644
--- a/src/main/org/apache/tools/mail/MailMessage.java
+++ b/src/main/org/apache/tools/mail/MailMessage.java
@@ -46,14 +46,15 @@ import java.util.stream.Collectors;
* easier to install, and has an Open Source license.
* <p>
* It can be used like this:
- * <blockquote><pre>
+ * </p>
+ * <pre>
* String mailhost = "localhost"; // or another mail host
* String from = "Mail Message Servlet <MailMessage@server.com>";
* String to = "to@you.com";
* String cc1 = "cc1@you.com";
* String cc2 = "cc2@you.com";
* String bcc = "bcc@you.com";
- *
+ *
* MailMessage msg = new MailMessage(mailhost);
* msg.setPort(25);
* msg.from(from);
@@ -63,16 +64,16 @@ import java.util.stream.Collectors;
* msg.bcc(bcc);
* msg.setSubject("Test subject");
* PrintStream out = msg.getPrintStream();
- *
+ *
* Enumeration enum = req.getParameterNames();
* while (enum.hasMoreElements()) {
* String name = (String)enum.nextElement();
* String value = req.getParameter(name);
* out.println(name + " = " + value);
* }
- *
+ *
* msg.sendAndClose();
- * </pre></blockquote>
+ * </pre>
* <p>
* Be sure to set the from address, then set the recipient
* addresses, then set the subject and other headers, then get the
@@ -80,14 +81,17 @@ import java.util.stream.Collectors;
* The class does minimal error checking internally; it counts on the mail
* host to complain if there's any malformatted input or out of order
* execution.
+ * </p>
* <p>
* An attachment mechanism based on RFC 1521 could be implemented on top of
* this class. In the meanwhile, JavaMail is the best solution for sending
* email with attachments.
+ * </p>
* <p>
* Still to do:
+ * </p>
* <ul>
- * <li>Figure out how to close the connection in case of error
+ * <li>Figure out how to close the connection in case of error</li>
* </ul>
*
* @version 1.1, 2000/03/19, added angle brackets to address, helps some servers
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/mail/SmtpResponseReader.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/mail/SmtpResponseReader.java b/src/main/org/apache/tools/mail/SmtpResponseReader.java
index b6b3172..69b11b4 100644
--- a/src/main/org/apache/tools/mail/SmtpResponseReader.java
+++ b/src/main/org/apache/tools/mail/SmtpResponseReader.java
@@ -47,7 +47,7 @@ public class SmtpResponseReader {
/**
* Read until the server indicates that the response is complete.
*
- * @return Responsecode (3 digits) + Blank + Text from all
+ * @return Response code (3 digits) + Blank + Text from all
* response line concatenated (with blanks replacing the \r\n
* sequences).
* @throws IOException on error.
@@ -92,7 +92,7 @@ public class SmtpResponseReader {
}
/**
- * Append the text from this line of the resonse.
+ * Append the text from this line of the response.
*/
private static void appendTo(StringBuilder target, String line) {
// CheckStyle:MagicNumber OFF
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/tar/TarEntry.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/tar/TarEntry.java b/src/main/org/apache/tools/tar/TarEntry.java
index 86024ea..fad702f 100644
--- a/src/main/org/apache/tools/tar/TarEntry.java
+++ b/src/main/org/apache/tools/tar/TarEntry.java
@@ -38,17 +38,19 @@ import org.apache.tools.zip.ZipEncoding;
* they are to be used.
* <p>
* TarEntries that are created from the header bytes read from
- * an archive are instantiated with the TarEntry( byte[] )
+ * an archive are instantiated with the TarEntry(byte[])
* constructor. These entries will be used when extracting from
* or listing the contents of an archive. These entries have their
* header filled in using the header bytes. They also set the File
* to null, since they reference an archive entry not a file.
+ * </p>
* <p>
* TarEntries that are created from Files that are to be written
- * into an archive are instantiated with the TarEntry( File )
+ * into an archive are instantiated with the TarEntry(File)
* constructor. These entries have their header filled in using
* the File's information. They also keep a reference to the File
* for convenience when writing entries.
+ * </p>
* <p>
* Finally, TarEntries can be constructed from nothing but a name.
* This allows the programmer to construct the entry by hand, for
@@ -56,8 +58,7 @@ import org.apache.tools.zip.ZipEncoding;
* the archive, and the header information is constructed from
* other information. In this case the header fields are set to
* defaults and the File is set to null.
- *
- * <p>
+ * </p>
* The C structure for a Tar Entry's header is:
* <pre>
* struct header {
@@ -84,8 +85,6 @@ import org.apache.tools.zip.ZipEncoding;
* field is the binary representation of the number.
* See TarUtils.parseOctalOrBinary.
* </pre>
- *
- * <p>
* The C structure for a old GNU Tar Entry's header is:
* <pre>
* struct oldgnu_header {
@@ -108,7 +107,6 @@ import org.apache.tools.zip.ZipEncoding;
* char numbytes[12]; // offset 12
* };
* </pre>
- *
*/
public class TarEntry implements TarConstants {
@@ -1023,7 +1021,7 @@ public class TarEntry implements TarConstants {
/**
* Strips Windows' drive letter as well as any leading slashes,
- * turns path separators into forward slahes.
+ * turns path separators into forward slashes.
*/
private static String normalizeFileName(String fileName,
boolean preserveLeadingSlashes) {
@@ -1083,10 +1081,10 @@ public class TarEntry implements TarConstants {
/**
* Check if buffer contents matches Ascii String.
*
- * @param expected
- * @param buffer
- * @param offset
- * @param length
+ * @param expected String
+ * @param buffer byte[]
+ * @param offset int
+ * @param length int
* @return {@code true} if buffer is the same as the expected string
*/
private static boolean matchAsciiBuffer(String expected, byte[] buffer,
@@ -1105,13 +1103,13 @@ public class TarEntry implements TarConstants {
/**
* Compare byte buffers, optionally ignoring trailing nulls
*
- * @param buffer1
- * @param offset1
- * @param length1
- * @param buffer2
- * @param offset2
- * @param length2
- * @param ignoreTrailingNulls
+ * @param buffer1 byte[]
+ * @param offset1 int
+ * @param length1 int
+ * @param buffer2 byte[]
+ * @param offset2 int
+ * @param length2 int
+ * @param ignoreTrailingNulls boolean
* @return {@code true} if buffer1 and buffer2 have same contents, having regard to trailing nulls
*/
private static boolean isEqual(
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/tar/TarInputStream.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/tar/TarInputStream.java b/src/main/org/apache/tools/tar/TarInputStream.java
index 82c0a0d..bacc200 100644
--- a/src/main/org/apache/tools/tar/TarInputStream.java
+++ b/src/main/org/apache/tools/tar/TarInputStream.java
@@ -62,7 +62,7 @@ public class TarInputStream extends FilterInputStream {
/**
* This contents of this array is not used at all in this class,
- * it is only here to avoid repreated object creation during calls
+ * it is only here to avoid repeated object creation during calls
* to the no-arg read method.
*/
protected byte[] oneBuf;
@@ -541,7 +541,7 @@ public class TarInputStream extends FilterInputStream {
/**
* Reads a byte from the current tar archive entry.
*
- * This method simply calls read( byte[], int, int ).
+ * This method simply calls read(byte[], int, int).
*
* @return The byte read, or -1 at EOF.
* @throws IOException on error
@@ -658,6 +658,9 @@ public class TarInputStream extends FilterInputStream {
* Whether this class is able to read the given entry.
*
* <p>May return false if the current entry is a sparse file.</p>
+ *
+ * @param te TarEntry
+ * @return boolean
*/
public boolean canReadEntryData(TarEntry te) {
return !te.isGNUSparse();
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/tar/TarOutputStream.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/tar/TarOutputStream.java b/src/main/org/apache/tools/tar/TarOutputStream.java
index cacc686..f2f0943 100644
--- a/src/main/org/apache/tools/tar/TarOutputStream.java
+++ b/src/main/org/apache/tools/tar/TarOutputStream.java
@@ -94,6 +94,7 @@ public class TarOutputStream extends FilterOutputStream {
/**
* Constructor for TarInputStream.
+ *
* @param os the output stream to use
*/
public TarOutputStream(OutputStream os) {
@@ -102,6 +103,7 @@ public class TarOutputStream extends FilterOutputStream {
/**
* Constructor for TarInputStream.
+ *
* @param os the output stream to use
* @param encoding name of the encoding to use for file names
*/
@@ -111,6 +113,7 @@ public class TarOutputStream extends FilterOutputStream {
/**
* Constructor for TarInputStream.
+ *
* @param os the output stream to use
* @param blockSize the block size to use
*/
@@ -120,6 +123,7 @@ public class TarOutputStream extends FilterOutputStream {
/**
* Constructor for TarInputStream.
+ *
* @param os the output stream to use
* @param blockSize the block size to use
* @param encoding name of the encoding to use for file names
@@ -130,6 +134,7 @@ public class TarOutputStream extends FilterOutputStream {
/**
* Constructor for TarInputStream.
+ *
* @param os the output stream to use
* @param blockSize the block size to use
* @param recordSize the record size to use
@@ -140,6 +145,7 @@ public class TarOutputStream extends FilterOutputStream {
/**
* Constructor for TarInputStream.
+ *
* @param os the output stream to use
* @param blockSize the block size to use
* @param recordSize the record size to use
@@ -163,6 +169,7 @@ public class TarOutputStream extends FilterOutputStream {
* This can be LONGFILE_ERROR(0), LONGFILE_TRUNCATE(1) or LONGFILE_GNU(2).
* This specifies the treatment of long file names (names >= TarConstants.NAMELEN).
* Default is LONGFILE_ERROR.
+ *
* @param longFileMode the mode to use
*/
public void setLongFileMode(int longFileMode) {
@@ -174,6 +181,7 @@ public class TarOutputStream extends FilterOutputStream {
* This can be BIGNUMBER_ERROR(0), BIGNUMBER_POSIX(1) or BIGNUMBER_STAR(2).
* This specifies the treatment of big files (sizes > TarConstants.MAXSIZE) and other numeric values to big to fit into a traditional tar header.
* Default is BIGNUMBER_ERROR.
+ *
* @param bigNumberMode the mode to use
*/
public void setBigNumberMode(int bigNumberMode) {
@@ -182,6 +190,8 @@ public class TarOutputStream extends FilterOutputStream {
/**
* Whether to add a PAX extension header for non-ASCII file names.
+ *
+ * @param b boolean
*/
public void setAddPaxHeadersForNonAsciiNames(boolean b) {
addPaxHeadersForNonAsciiNames = b;
@@ -358,7 +368,7 @@ public class TarOutputStream extends FilterOutputStream {
/**
* Writes a byte to the current tar archive entry.
*
- * This method simply calls read( byte[], int, int ).
+ * This method simply calls read(byte[], int, int).
*
* @param b The byte written.
* @throws IOException on error
@@ -373,7 +383,7 @@ public class TarOutputStream extends FilterOutputStream {
/**
* Writes bytes to the current tar archive entry.
*
- * This method simply calls write( byte[], int, int ).
+ * This method simply calls write(byte[], int, int).
*
* @param wBuf The buffer to write to the archive.
* @throws IOException on error
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/tar/TarUtils.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/tar/TarUtils.java b/src/main/org/apache/tools/tar/TarUtils.java
index 5fa2e01..70e6a44 100644
--- a/src/main/org/apache/tools/tar/TarUtils.java
+++ b/src/main/org/apache/tools/tar/TarUtils.java
@@ -280,6 +280,7 @@ public class TarUtils {
* @param length The maximum number of bytes to parse.
* @param encoding name of the encoding to use for file names
* @return The entry name.
+ * @throws IOException if decode fails
*/
public static String parseName(final byte[] buffer, final int offset,
final int length,
@@ -344,6 +345,7 @@ public class TarUtils {
* @param length The maximum number of header bytes to copy.
* @param encoding name of the encoding to use for file names
* @return The updated offset, i.e. offset + length
+ * @throws IOException if encode fails
*/
public static int formatNameBytes(final String name, final byte[] buf, final int offset,
final int length,
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/AbstractUnicodeExtraField.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/AbstractUnicodeExtraField.java b/src/main/org/apache/tools/zip/AbstractUnicodeExtraField.java
index ab56f46..0f236d4 100644
--- a/src/main/org/apache/tools/zip/AbstractUnicodeExtraField.java
+++ b/src/main/org/apache/tools/zip/AbstractUnicodeExtraField.java
@@ -42,7 +42,7 @@ public abstract class AbstractUnicodeExtraField implements ZipExtraField {
* file.
* @param off The offset of the encoded filename or comment in
* <code>bytes</code>.
- * @param len The length of the encoded filename or commentin
+ * @param len The length of the encoded filename or comment in
* <code>bytes</code>.
*/
protected AbstractUnicodeExtraField(final String text, final byte[] bytes, final int off,
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/AsiExtraField.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/AsiExtraField.java b/src/main/org/apache/tools/zip/AsiExtraField.java
index fb8227d..0108ee2 100644
--- a/src/main/org/apache/tools/zip/AsiExtraField.java
+++ b/src/main/org/apache/tools/zip/AsiExtraField.java
@@ -25,7 +25,7 @@ import java.util.zip.ZipException;
* Adds Unix file permission and UID/GID fields as well as symbolic
* link handling.
*
- * <p>This class uses the ASi extra field in the format:
+ * <p>This class uses the ASi extra field in the format:</p>
* <pre>
* Value Size Description
* ----- ---- -----------
@@ -39,7 +39,7 @@ import java.util.zip.ZipException;
* (var.) variable symbolic link filename
* </pre>
* taken from appnote.iz (Info-ZIP note, 981119) found at <a
- * href="ftp://ftp.uu.net/pub/archiving/zip/doc/">ftp://ftp.uu.net/pub/archiving/zip/doc/</a></p>
+ * href="ftp://ftp.uu.net/pub/archiving/zip/doc/">ftp://ftp.uu.net/pub/archiving/zip/doc/</a>
*
* <p>Short is two bytes and Long is four bytes in big endian byte and
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/ExtraFieldUtils.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/ExtraFieldUtils.java b/src/main/org/apache/tools/zip/ExtraFieldUtils.java
index 8a7355e..d7a6c9d 100644
--- a/src/main/org/apache/tools/zip/ExtraFieldUtils.java
+++ b/src/main/org/apache/tools/zip/ExtraFieldUtils.java
@@ -308,6 +308,8 @@ public class ExtraFieldUtils {
/**
* Key of the action to take.
+ *
+ * @return int
*/
public int getKey() { return key; }
}
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/FallbackZipEncoding.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/FallbackZipEncoding.java b/src/main/org/apache/tools/zip/FallbackZipEncoding.java
index 3edbb8e..96cff33 100644
--- a/src/main/org/apache/tools/zip/FallbackZipEncoding.java
+++ b/src/main/org/apache/tools/zip/FallbackZipEncoding.java
@@ -34,7 +34,7 @@ import java.nio.ByteBuffer;
* given name can be safely encoded or not.</p>
*
* <p>This implementation acts as a last resort implementation, when
- * neither {@link Simple8BitZipEnoding} nor {@link NioZipEncoding} is
+ * neither {@link Simple8BitZipEncoding} nor {@link NioZipEncoding} is
* available.</p>
*
* <p>The methods of this class are reentrant.</p>
@@ -61,16 +61,14 @@ class FallbackZipEncoding implements ZipEncoding {
}
/**
- * @see
- * org.apache.tools.zip.ZipEncoding#canEncode(java.lang.String)
+ * @see org.apache.tools.zip.ZipEncoding#canEncode(java.lang.String)
*/
public boolean canEncode(final String name) {
return true;
}
/**
- * @see
- * org.apache.tools.zip.ZipEncoding#encode(java.lang.String)
+ * @see org.apache.tools.zip.ZipEncoding#encode(java.lang.String)
*/
public ByteBuffer encode(final String name) throws IOException {
if (this.charset == null) { // i.e. use default charset, see no-args constructor
@@ -81,8 +79,7 @@ class FallbackZipEncoding implements ZipEncoding {
}
/**
- * @see
- * org.apache.tools.zip.ZipEncoding#decode(byte[])
+ * @see org.apache.tools.zip.ZipEncoding#decode(byte[])
*/
public String decode(final byte[] data) throws IOException {
if (this.charset == null) { // i.e. use default charset, see no-args constructor
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/GeneralPurposeBit.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/GeneralPurposeBit.java b/src/main/org/apache/tools/zip/GeneralPurposeBit.java
index a1af211..3246fbe 100644
--- a/src/main/org/apache/tools/zip/GeneralPurposeBit.java
+++ b/src/main/org/apache/tools/zip/GeneralPurposeBit.java
@@ -59,6 +59,8 @@ public final class GeneralPurposeBit implements Cloneable {
/**
* whether the current entry uses UTF8 for file name and comment.
+ *
+ * @return boolean
*/
public boolean usesUTF8ForNames() {
return languageEncodingFlag;
@@ -66,6 +68,8 @@ public final class GeneralPurposeBit implements Cloneable {
/**
* whether the current entry will use UTF8 for file name and comment.
+ *
+ * @param b boolean
*/
public void useUTF8ForNames(boolean b) {
languageEncodingFlag = b;
@@ -74,6 +78,8 @@ public final class GeneralPurposeBit implements Cloneable {
/**
* whether the current entry uses the data descriptor to store CRC
* and size information
+ *
+ * @return boolean
*/
public boolean usesDataDescriptor() {
return dataDescriptorFlag;
@@ -82,6 +88,8 @@ public final class GeneralPurposeBit implements Cloneable {
/**
* whether the current entry will use the data descriptor to store
* CRC and size information
+ *
+ * @param b boolean
*/
public void useDataDescriptor(boolean b) {
dataDescriptorFlag = b;
@@ -89,6 +97,8 @@ public final class GeneralPurposeBit implements Cloneable {
/**
* whether the current entry is encrypted
+ *
+ * @return boolean
*/
public boolean usesEncryption() {
return encryptionFlag;
@@ -96,6 +106,8 @@ public final class GeneralPurposeBit implements Cloneable {
/**
* whether the current entry will be encrypted
+ *
+ * @param b boolean
*/
public void useEncryption(boolean b) {
encryptionFlag = b;
@@ -103,6 +115,8 @@ public final class GeneralPurposeBit implements Cloneable {
/**
* whether the current entry is encrypted using strong encryption
+ *
+ * @return boolean
*/
public boolean usesStrongEncryption() {
return encryptionFlag && strongEncryptionFlag;
@@ -110,6 +124,8 @@ public final class GeneralPurposeBit implements Cloneable {
/**
* whether the current entry will be encrypted using strong encryption
+ *
+ * @param b boolean
*/
public void useStrongEncryption(boolean b) {
strongEncryptionFlag = b;
@@ -120,6 +136,8 @@ public final class GeneralPurposeBit implements Cloneable {
/**
* Encodes the set bits in a form suitable for ZIP archives.
+ *
+ * @return byte[]
*/
public byte[] encode() {
byte[] result = new byte[2];
@@ -131,7 +149,7 @@ public final class GeneralPurposeBit implements Cloneable {
* Encodes the set bits in a form suitable for ZIP archives.
*
* @param buf the output buffer
- * @param offset
+ * @param offset
* The offset within the output buffer of the first byte to be written.
* must be non-negative and no larger than <tt>buf.length-2</tt>
*/
@@ -148,8 +166,10 @@ public final class GeneralPurposeBit implements Cloneable {
/**
* Parses the supported flags from the given archive data.
+ *
* @param data local file header or a central directory entry.
* @param offset offset at which the general purpose bit starts
+ * @return GeneralPurposeBit
*/
public static GeneralPurposeBit parse(final byte[] data, final int offset) {
final int generalPurposeFlag = ZipShort.getValue(data, offset);
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/NioZipEncoding.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/NioZipEncoding.java b/src/main/org/apache/tools/zip/NioZipEncoding.java
index 63d33ff..462b519 100644
--- a/src/main/org/apache/tools/zip/NioZipEncoding.java
+++ b/src/main/org/apache/tools/zip/NioZipEncoding.java
@@ -51,8 +51,7 @@ class NioZipEncoding implements ZipEncoding {
}
/**
- * @see
- * org.apache.tools.zip.ZipEncoding#canEncode(java.lang.String)
+ * @see org.apache.tools.zip.ZipEncoding#canEncode(java.lang.String)
*/
public boolean canEncode(final String name) {
final CharsetEncoder enc = this.charset.newEncoder();
@@ -63,8 +62,7 @@ class NioZipEncoding implements ZipEncoding {
}
/**
- * @see
- * org.apache.tools.zip.ZipEncoding#encode(java.lang.String)
+ * @see org.apache.tools.zip.ZipEncoding#encode(java.lang.String)
*/
public ByteBuffer encode(final String name) {
final CharsetEncoder enc = this.charset.newEncoder();
@@ -110,8 +108,7 @@ class NioZipEncoding implements ZipEncoding {
}
/**
- * @see
- * org.apache.tools.zip.ZipEncoding#decode(byte[])
+ * @see org.apache.tools.zip.ZipEncoding#decode(byte[])
*/
public String decode(final byte[] data) throws IOException {
return this.charset.newDecoder()
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/Simple8BitZipEncoding.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/Simple8BitZipEncoding.java b/src/main/org/apache/tools/zip/Simple8BitZipEncoding.java
index 57a838c..cd40070 100644
--- a/src/main/org/apache/tools/zip/Simple8BitZipEncoding.java
+++ b/src/main/org/apache/tools/zip/Simple8BitZipEncoding.java
@@ -212,8 +212,7 @@ class Simple8BitZipEncoding implements ZipEncoding {
}
/**
- * @see
- * org.apache.tools.zip.ZipEncoding#canEncode(java.lang.String)
+ * @see org.apache.tools.zip.ZipEncoding#canEncode(java.lang.String)
*/
public boolean canEncode(final String name) {
@@ -230,8 +229,7 @@ class Simple8BitZipEncoding implements ZipEncoding {
}
/**
- * @see
- * org.apache.tools.zip.ZipEncoding#encode(java.lang.String)
+ * @see org.apache.tools.zip.ZipEncoding#encode(java.lang.String)
*/
public ByteBuffer encode(final String name) {
ByteBuffer out = ByteBuffer.allocate(name.length()
@@ -257,8 +255,7 @@ class Simple8BitZipEncoding implements ZipEncoding {
}
/**
- * @see
- * org.apache.tools.zip.ZipEncoding#decode(byte[])
+ * @see org.apache.tools.zip.ZipEncoding#decode(byte[])
*/
public String decode(final byte[] data) throws IOException {
final char [] ret = new char[data.length];
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/UnicodeCommentExtraField.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/UnicodeCommentExtraField.java b/src/main/org/apache/tools/zip/UnicodeCommentExtraField.java
index 51550fe..ccc51fa 100644
--- a/src/main/org/apache/tools/zip/UnicodeCommentExtraField.java
+++ b/src/main/org/apache/tools/zip/UnicodeCommentExtraField.java
@@ -24,9 +24,8 @@ package org.apache.tools.zip;
* <p>Stores the UTF-8 version of the file comment as stored in the
* central directory header.</p>
*
- * <p>See {@link
- * "http://www.pkware.com/documents/casestudies/APPNOTE.TXT PKWARE's
- * APPNOTE.TXT, section 4.6.8"}.</p>
+ * <p>See <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWARE's
+ * APPNOTE.TXT, section 4.6.8</a>.</p>
*
*/
public class UnicodeCommentExtraField extends AbstractUnicodeExtraField {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/UnicodePathExtraField.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/UnicodePathExtraField.java b/src/main/org/apache/tools/zip/UnicodePathExtraField.java
index 8b045a1..7638edd 100644
--- a/src/main/org/apache/tools/zip/UnicodePathExtraField.java
+++ b/src/main/org/apache/tools/zip/UnicodePathExtraField.java
@@ -24,15 +24,14 @@ package org.apache.tools.zip;
* <p>Stores the UTF-8 version of the file name field as stored in the
* local header and central directory header.</p>
*
- * <p>See {@link
- * "http://www.pkware.com/documents/casestudies/APPNOTE.TXT PKWARE's
- * APPNOTE.TXT, section 4.6.9"}.</p>
+ * <p>See <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWARE's
+ * APPNOTE.TXT, section 4.6.9</a>.</p>
*/
public class UnicodePathExtraField extends AbstractUnicodeExtraField {
public static final ZipShort UPATH_ID = new ZipShort(0x7075);
- public UnicodePathExtraField () {
+ public UnicodePathExtraField() {
}
/**
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/UnparseableExtraFieldData.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/UnparseableExtraFieldData.java b/src/main/org/apache/tools/zip/UnparseableExtraFieldData.java
index 92d3002..5c1a8d0 100644
--- a/src/main/org/apache/tools/zip/UnparseableExtraFieldData.java
+++ b/src/main/org/apache/tools/zip/UnparseableExtraFieldData.java
@@ -22,8 +22,8 @@ package org.apache.tools.zip;
* Wrapper for extra field data that doesn't conform to the recommended format of header-tag + size + data.
*
* <p>The header-id is artificial (and not listed as a known ID in
- * {@link <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">
- * APPNOTE.TXT</a>}). Since it isn't used anywhere except to satisfy the
+ * <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">APPNOTE.TXT</a>).
+ * Since it isn't used anywhere except to satisfy the
* ZipExtraField contract it shouldn't matter anyway.</p>
*
* @since Ant 1.8.1
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/UnsupportedZipFeatureException.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/UnsupportedZipFeatureException.java b/src/main/org/apache/tools/zip/UnsupportedZipFeatureException.java
index 291d494..52df40d 100644
--- a/src/main/org/apache/tools/zip/UnsupportedZipFeatureException.java
+++ b/src/main/org/apache/tools/zip/UnsupportedZipFeatureException.java
@@ -46,6 +46,8 @@ public class UnsupportedZipFeatureException extends ZipException {
/**
* The unsupported feature that has been used.
+ *
+ * @return Feature
*/
public Feature getFeature() {
return reason;
@@ -53,6 +55,8 @@ public class UnsupportedZipFeatureException extends ZipException {
/**
* The entry using the unsupported feature.
+ *
+ * @return ZipEntry
*/
public ZipEntry getEntry() {
return entry;
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/Zip64ExtendedInformationExtraField.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/Zip64ExtendedInformationExtraField.java b/src/main/org/apache/tools/zip/Zip64ExtendedInformationExtraField.java
index 16502ac..2cc0a53 100644
--- a/src/main/org/apache/tools/zip/Zip64ExtendedInformationExtraField.java
+++ b/src/main/org/apache/tools/zip/Zip64ExtendedInformationExtraField.java
@@ -27,9 +27,8 @@ import java.util.zip.ZipException;
* Holds size and other extended information for entries that use Zip64
* features.
*
- * <p>See {@link
- * "http://www.pkware.com/documents/casestudies/APPNOTE.TXT PKWARE's
- * APPNOTE.TXT, section 4.5.3"}.</p>
+ * <p>See <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWARE's
+ * APPNOTE.TXT, section 4.5.3</a>.</p>
*
* <p>Currently Ant doesn't support encrypting the
* central directory so the note about masking doesn't apply.</p>
@@ -86,7 +85,8 @@ public class Zip64ExtendedInformationExtraField
*
* @param size the entry's original size
* @param compressedSize the entry's compressed size
- *
+ * @param relativeHeaderOffset ZipEightByteInteger
+ * @param diskStart ZipLong
* @throws IllegalArgumentException if size or compressedSize is null
*/
public Zip64ExtendedInformationExtraField(ZipEightByteInteger size,
@@ -210,6 +210,12 @@ public class Zip64ExtendedInformationExtraField
* field are optional and must only be present if their corresponding
* entry inside the central directory contains the correct magic
* value.</p>
+ *
+ * @param hasUncompressedSize boolean
+ * @param hasCompressedSize boolean
+ * @param hasRelativeHeaderOffset boolean
+ * @param hasDiskStart boolean
+ * @throws ZipException if expected length of central directory data is incorrect
*/
public void reparseCentralDirectoryData(boolean hasUncompressedSize,
boolean hasCompressedSize,
@@ -253,6 +259,8 @@ public class Zip64ExtendedInformationExtraField
/**
* The uncompressed size stored in this extra field.
+ *
+ * @return ZipEightByteInteger
*/
public ZipEightByteInteger getSize() {
return size;
@@ -260,6 +268,8 @@ public class Zip64ExtendedInformationExtraField
/**
* The uncompressed size stored in this extra field.
+ *
+ * @param size ZipEightByteInteger
*/
public void setSize(ZipEightByteInteger size) {
this.size = size;
@@ -267,6 +277,8 @@ public class Zip64ExtendedInformationExtraField
/**
* The compressed size stored in this extra field.
+ *
+ * @return ZipEightByteInteger
*/
public ZipEightByteInteger getCompressedSize() {
return compressedSize;
@@ -274,6 +286,8 @@ public class Zip64ExtendedInformationExtraField
/**
* The uncompressed size stored in this extra field.
+ *
+ * @param compressedSize ZipEightByteInteger
*/
public void setCompressedSize(ZipEightByteInteger compressedSize) {
this.compressedSize = compressedSize;
@@ -281,6 +295,8 @@ public class Zip64ExtendedInformationExtraField
/**
* The relative header offset stored in this extra field.
+ *
+ * @return ZipEightByteInteger
*/
public ZipEightByteInteger getRelativeHeaderOffset() {
return relativeHeaderOffset;
@@ -288,6 +304,8 @@ public class Zip64ExtendedInformationExtraField
/**
* The relative header offset stored in this extra field.
+ *
+ * @param rho ZipEightByteInteger
*/
public void setRelativeHeaderOffset(ZipEightByteInteger rho) {
relativeHeaderOffset = rho;
@@ -295,6 +313,8 @@ public class Zip64ExtendedInformationExtraField
/**
* The disk start number stored in this extra field.
+ *
+ * @return ZipLong
*/
public ZipLong getDiskStartNumber() {
return diskStart;
@@ -302,6 +322,8 @@ public class Zip64ExtendedInformationExtraField
/**
* The disk start number stored in this extra field.
+ *
+ * @param ds ZipLong
*/
public void setDiskStartNumber(ZipLong ds) {
diskStart = ds;
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/ZipEncoding.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/ZipEncoding.java b/src/main/org/apache/tools/zip/ZipEncoding.java
index 7265383..719caf5 100644
--- a/src/main/org/apache/tools/zip/ZipEncoding.java
+++ b/src/main/org/apache/tools/zip/ZipEncoding.java
@@ -71,14 +71,14 @@ public interface ZipEncoding {
* beginning of the encoded result, the byte buffer has a
* backing array and the limit of the byte buffer points
* to the end of the encoded result.
- * @throws IOException
+ * @throws IOException if something goes wrong
*/
ByteBuffer encode(String name) throws IOException;
/**
* @param data The byte values to decode.
* @return The decoded string.
- * @throws IOException
+ * @throws IOException if something goes wrong
*/
String decode(byte [] data) throws IOException;
}
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/ZipEntry.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/ZipEntry.java b/src/main/org/apache/tools/zip/ZipEntry.java
index df3f840..eac5f63 100644
--- a/src/main/org/apache/tools/zip/ZipEntry.java
+++ b/src/main/org/apache/tools/zip/ZipEntry.java
@@ -30,8 +30,7 @@ import java.util.zip.ZipException;
* access to the internal and external file attributes.
*
* <p>The extra data is expected to follow the recommendation of
- * {@link <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">
- * APPNOTE.txt</a>}:</p>
+ * <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">APPNOTE.txt</a>:</p>
* <ul>
* <li>the extra byte array consists of a sequence of extra fields</li>
* <li>each extra fields starts by a two byte header id followed by
@@ -59,8 +58,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
* The {@link java.util.zip.ZipEntry} base class only supports
* the compression methods STORED and DEFLATED. We override the
* field so that any compression methods can be used.
- * <p>
- * The default value -1 means that the method has not been specified.
+ * <p>The default value -1 means that the method has not been specified.</p>
*/
private int method = -1;
@@ -158,6 +156,9 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
* the file is a directory. If the file is not a directory a
* potential trailing forward slash will be stripped from the
* entry name.</p>
+ *
+ * @param inputFile File
+ * @param entryName String
*/
public ZipEntry(final File inputFile, final String entryName) {
this(inputFile.isDirectory() && !entryName.endsWith("/") ?
@@ -171,6 +172,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Overwrite clone.
+ *
* @return a cloned copy of this ZipEntry
* @since 1.1
*/
@@ -221,6 +223,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Sets the internal file attributes.
+ *
* @param value an <code>int</code> value
* @since 1.1
*/
@@ -230,6 +233,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Retrieves the external file attributes.
+ *
* @return the external file attributes
* @since 1.1
*/
@@ -239,6 +243,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Sets the external file attributes.
+ *
* @param value an <code>long</code> value
* @since 1.1
*/
@@ -249,6 +254,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Sets Unix permissions in a way that is understood by Info-Zip's
* unzip command.
+ *
* @param mode an <code>int</code> value
* @since Ant 1.5.2
*/
@@ -265,6 +271,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Unix permission.
+ *
* @return the unix permissions
* @since Ant 1.6
*/
@@ -288,6 +295,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Set the platform (UNIX or FAT).
+ *
* @param platform an <code>int</code> value - 0 is FAT, 3 is UNIX
* @since 1.9
*/
@@ -297,6 +305,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Replaces all currently attached extra fields with the new array.
+ *
* @param fields an array of extra fields
* @since 1.1
*/
@@ -315,6 +324,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Retrieves all extra fields that have been parsed successfully.
+ *
* @return an array of the extra fields
*/
public ZipExtraField[] getExtraFields() {
@@ -323,6 +333,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Retrieves extra fields.
+ *
* @param includeUnparseable whether to also return unparseable
* extra fields as {@link UnparseableExtraFieldData} if such data
* exists.
@@ -378,6 +389,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Get all extra fields, including unparseable ones.
+ *
* @return An array of all extra fields. Not necessarily a copy of internal data structures, hence private method
*/
private ZipExtraField[] getAllExtraFieldsNoCopy() {
@@ -393,6 +405,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
*
* <p>If no extra field of the same type exists, the field will be
* added as last field.</p>
+ *
* @param ze an extra field
* @since 1.1
*/
@@ -420,6 +433,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
* of the same type.
*
* <p>The new extra field will be the first one.</p>
+ *
* @param ze an extra field
* @since 1.1
*/
@@ -443,6 +457,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Remove an extra field.
+ *
* @param type the type of extra field to remove
* @since 1.1
*/
@@ -477,6 +492,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Looks up an extra field by its header id.
*
+ * @param type ZipShort
* @return null if no such field exists.
*/
public ZipExtraField getExtraField(final ZipShort type) {
@@ -503,10 +519,11 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
* Parses the given bytes as extra field data and consumes any
* unparseable data as an {@link UnparseableExtraFieldData}
* instance.
+ *
* @param extra an array of bytes to be parsed into extra fields
* @throws RuntimeException if the bytes cannot be parsed
- * @since 1.1
* @throws RuntimeException on error
+ * @since 1.1
*/
@Override
public void setExtra(final byte[] extra) throws RuntimeException {
@@ -536,6 +553,8 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Sets the central directory part of extra fields.
+ *
+ * @param b boolean
*/
public void setCentralDirectoryExtra(final byte[] b) {
try {
@@ -550,6 +569,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Retrieves the extra data for the local file data.
+ *
* @return the extra data for local file
* @since 1.1
*/
@@ -560,6 +580,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Retrieves the extra data for the central directory.
+ *
* @return the central directory extra data
* @since 1.1
*/
@@ -572,6 +593,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
*
* <p>This either stores the size for later usage or invokes
* setCompressedSize via reflection.</p>
+ *
* @param size the size to use
* @deprecated since 1.7.
* Use setCompressedSize directly.
@@ -584,6 +606,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Get the name of the entry.
+ *
* @return the entry name
* @since 1.9
*/
@@ -594,6 +617,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Is this entry a directory?
+ *
* @return true if the entry is a directory
* @since 1.10
*/
@@ -604,6 +628,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Set the name of the entry.
+ *
* @param name the name to use
*/
protected void setName(String name) {
@@ -616,6 +641,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Gets the uncompressed size of the entry data.
+ *
* @return the entry size
*/
@Override
@@ -625,6 +651,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Sets the uncompressed size of the entry data.
+ *
* @param size the uncompressed size in bytes
* @exception IllegalArgumentException if the specified size is less
* than 0
@@ -640,6 +667,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Sets the name using the raw bytes and the string created from
* it by guessing or using the configured encoding.
+ *
* @param name the name to use created from the raw bytes using
* the guessed or configured encoding
* @param rawName the bytes originally read as name from the
@@ -656,6 +684,8 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
*
* <p>This method will return null if this instance has not been
* read from an archive.</p>
+ *
+ * @return byte[]
*/
public byte[] getRawName() {
if (rawName != null) {
@@ -669,6 +699,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* Get the hashCode of the entry.
* This uses the name as the hashcode.
+ *
* @return a hashcode.
* @since Ant 1.7
*/
@@ -676,13 +707,15 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
public int hashCode() {
// this method has severe consequences on performance. We cannot rely
// on the super.hashCode() method since super.getName() always return
- // the empty string in the current implemention (there's no setter)
+ // the empty string in the current implementation (there's no setter)
// so it is basically draining the performance of a hashmap lookup
return getName().hashCode();
}
/**
* The "general purpose bit" field.
+ *
+ * @return GeneralPurposeBit
*/
public GeneralPurposeBit getGeneralPurposeBit() {
return gpb;
@@ -690,6 +723,8 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
/**
* The "general purpose bit" field.
+ *
+ * @param b GeneralPurposeBit
*/
public void setGeneralPurposeBit(final GeneralPurposeBit b) {
gpb = b;
@@ -700,6 +735,7 @@ public class ZipEntry extends java.util.zip.ZipEntry implements Cloneable {
* data - otherwise merge the fields assuming the existing fields
* and the new fields stem from different locations inside the
* archive.
+ *
* @param f the extra fields to merge
* @param local whether the new fields originate from local data
*/
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/ZipFile.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/ZipFile.java b/src/main/org/apache/tools/zip/ZipFile.java
index 3f4019a..9a51f5c 100644
--- a/src/main/org/apache/tools/zip/ZipFile.java
+++ b/src/main/org/apache/tools/zip/ZipFile.java
@@ -315,7 +315,7 @@ public class ZipFile implements Closeable {
* the archive's central directory.
*
* @param name name of the entry.
- * @return the Iterable<ZipEntry> corresponding to the
+ * @return the Iterable<ZipEntry> corresponding to the
* given name
* @since 1.9.2
*/
@@ -330,7 +330,7 @@ public class ZipFile implements Closeable {
* appear within the archive.
*
* @param name name of the entry.
- * @return the Iterable<ZipEntry> corresponding to the
+ * @return the Iterable<ZipEntry> corresponding to the
* given name
* @since 1.9.2
*/
@@ -347,6 +347,9 @@ public class ZipFile implements Closeable {
*
* <p>May return false if it is set up to use encryption or a
* compression method that hasn't been implemented yet.</p>
+ *
+ * @param ze ZipEntry
+ * @return boolean
*/
public boolean canReadEntryData(final ZipEntry ze) {
return ZipUtil.canHandleEntryData(ze);
@@ -365,7 +368,7 @@ public class ZipFile implements Closeable {
if (!(ze instanceof Entry)) {
return null;
}
- // cast valididty is checked just above
+ // cast validity is checked just above
final OffsetEntry offsetEntry = ((Entry) ze).getOffsetEntry();
ZipUtil.checkRequestedFeatures(ze);
final long start = offsetEntry.dataOffset;
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/ZipOutputStream.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/ZipOutputStream.java b/src/main/org/apache/tools/zip/ZipOutputStream.java
index 23f4eac..db934c8 100644
--- a/src/main/org/apache/tools/zip/ZipOutputStream.java
+++ b/src/main/org/apache/tools/zip/ZipOutputStream.java
@@ -262,9 +262,10 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* The zip encoding to use for filenames and the file comment.
- *
+ * <p>
* This field is of internal use and will be set in {@link
* #setEncoding(String)}.
+ * </p>
*/
private ZipEncoding zipEncoding =
ZipEncodingHelper.getZipEncoding(DEFAULT_ENCODING);
@@ -407,6 +408,8 @@ public class ZipOutputStream extends FilterOutputStream {
* encoding is UTF-8.
*
* <p>Defaults to true.</p>
+ *
+ * @param b boolean
*/
public void setUseLanguageEncodingFlag(boolean b) {
useUTF8Flag = b && ZipEncodingHelper.isUTF8(encoding);
@@ -416,6 +419,8 @@ public class ZipOutputStream extends FilterOutputStream {
* Whether to create Unicode Extra Fields.
*
* <p>Defaults to NEVER.</p>
+ *
+ * @param b boolean
*/
public void setCreateUnicodeExtraFields(UnicodeExtraFieldPolicy b) {
createUnicodeExtraFields = b;
@@ -426,6 +431,8 @@ public class ZipOutputStream extends FilterOutputStream {
* the file name cannot be encoded using the specified encoding.
*
* <p>Defaults to false.</p>
+ *
+ * @param b boolean
*/
public void setFallbackToUTF8(boolean b) {
fallbackToUTF8 = b;
@@ -473,6 +480,7 @@ public class ZipOutputStream extends FilterOutputStream {
* size and data is written to a non-seekable stream - in this
* case the default is {@link Zip64Mode#Never Never}.</p>
*
+ * @param mode Zip64Mode
* @since 1.3
*/
public void setUseZip64(Zip64Mode mode) {
@@ -585,6 +593,12 @@ public class ZipOutputStream extends FilterOutputStream {
* the values just written, verifies it isn't too big in the
* Zip64Mode.Never case and returns whether the entry would
* require a Zip64 extra field.
+ *
+ * @param bytesWritten long
+ * @param crc long
+ * @param effectiveMode Zip64Mode
+ * @return boolean
+ * @throws ZipException if size or CRC is incorrect
*/
private boolean handleSizesAndCrc(long bytesWritten, long crc,
Zip64Mode effectiveMode)
@@ -629,6 +643,10 @@ public class ZipOutputStream extends FilterOutputStream {
* the values just written, verifies it isn't too big in the
* Zip64Mode.Never case and returns whether the entry would
* require a Zip64 extra field.
+ *
+ * @param effectiveMode Zip64Mode
+ * @return boolean
+ * @throws ZipException if the entry is too big for Zip64Mode.Never
*/
private boolean checkIfNeedsZip64(Zip64Mode effectiveMode)
throws ZipException {
@@ -652,8 +670,10 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* When using random access output, write the local file header
- * and potentiall the ZIP64 extra containing the correct CRC and
+ * and potentially the ZIP64 extra containing the correct CRC and
* compressed/uncompressed sizes.
+ *
+ * @param actuallyNeedsZip64 boolean
*/
private void rewriteSizesAndCrc(boolean actuallyNeedsZip64)
throws IOException {
@@ -752,6 +772,8 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Provides default values for compression method and last
* modification time.
+ *
+ * @param entry ZipEntry
*/
private void setDefaults(ZipEntry entry) {
if (entry.getMethod() == -1) { // not specified
@@ -768,6 +790,8 @@ public class ZipOutputStream extends FilterOutputStream {
* that is written to a non-seekable output or the entry is too
* big to be written without Zip64 extra but the mode has been set
* to Never.
+ *
+ * @param effectiveMode Zip64Mode
*/
private void validateSizeInformation(Zip64Mode effectiveMode)
throws ZipException {
@@ -794,7 +818,7 @@ public class ZipOutputStream extends FilterOutputStream {
}
/**
- * Whether to addd a Zip64 extended information extra field to the
+ * Whether to add a Zip64 extended information extra field to the
* local file header.
*
* <p>Returns true if</p>
@@ -806,6 +830,9 @@ public class ZipOutputStream extends FilterOutputStream {
* other implementations if we add it (i.e. we can erase its
* usage</li>
* </ul>
+ *
+ * @param entry ZipEntry
+ * @param mode Zip64Mode
*/
private boolean shouldAddZip64Extra(ZipEntry entry, Zip64Mode mode) {
return mode == Zip64Mode.Always
@@ -817,6 +844,7 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Set the file comment.
+ *
* @param comment the comment
*/
public void setComment(String comment) {
@@ -827,6 +855,7 @@ public class ZipOutputStream extends FilterOutputStream {
* Sets the compression level for subsequent entries.
*
* <p>Default is Deflater.DEFAULT_COMPRESSION.</p>
+ *
* @param level the compression level.
* @throws IllegalArgumentException if an invalid compression
* level is specified.
@@ -846,6 +875,7 @@ public class ZipOutputStream extends FilterOutputStream {
* Sets the default compression method for subsequent entries.
*
* <p>Default is DEFLATED.</p>
+ *
* @param method an <code>int</code> from java.util.zip.ZipEntry
* @since 1.1
*/
@@ -858,6 +888,9 @@ public class ZipOutputStream extends FilterOutputStream {
*
* <p>May return false if it is set up to use encryption or a
* compression method that hasn't been implemented yet.</p>
+ *
+ * @param ae ZipEntry
+ * @return boolean
*/
public boolean canWriteEntryData(ZipEntry ae) {
return ZipUtil.canHandleEntryData(ae);
@@ -865,6 +898,7 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Writes bytes to ZIP entry.
+ *
* @param b the byte array to write
* @param offset the start position to write from
* @param length the number of bytes to write
@@ -887,6 +921,7 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Write bytes to output or random access file.
+ *
* @param data the byte array to write
* @throws IOException on error
*/
@@ -901,6 +936,10 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* write implementation for DEFLATED entries.
+ *
+ * @param b byte[]
+ * @param offset int
+ * @param length int
*/
private void writeDeflated(byte[]b, int offset, int length)
throws IOException {
@@ -929,7 +968,7 @@ public class ZipOutputStream extends FilterOutputStream {
* Closes this output stream and releases any system resources
* associated with the stream.
*
- * @exception IOException if an I/O error occurs.
+ * @throws IOException if an I/O error occurs.
* @throws Zip64RequiredException if the archive's size exceeds 4
* GByte or there are more than 65535 entries inside the archive
* and {@link #setUseZip64} is {@link Zip64Mode#Never}.
@@ -993,8 +1032,8 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Writes next block of compressed data to the output stream.
- * @throws IOException on error
*
+ * @throws IOException on error
* @since 1.14
*/
protected final void deflate() throws IOException {
@@ -1006,9 +1045,9 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Writes the local file header entry
+ *
* @param ze the entry to write
* @throws IOException on error
- *
* @since 1.1
*/
protected void writeLocalFileHeader(ZipEntry ze) throws IOException {
@@ -1091,6 +1130,10 @@ public class ZipOutputStream extends FilterOutputStream {
* Adds UnicodeExtra fields for name and file comment if mode is
* ALWAYS or the data cannot be encoded using the configured
* encoding.
+ *
+ * @param ze ZipEntry
+ * @param encodable boolean
+ * @param name ByteBuffer
*/
private void addUnicodeExtraFields(ZipEntry ze, boolean encodable,
ByteBuffer name)
@@ -1124,9 +1167,9 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Writes the data descriptor entry.
+ *
* @param ze the entry to write
* @throws IOException on error
- *
* @since 1.1
*/
protected void writeDataDescriptor(ZipEntry ze) throws IOException {
@@ -1146,6 +1189,7 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Writes the central file header entry.
+ *
* @param ze the entry to write
* @throws IOException on error
* @throws Zip64RequiredException if the archive's size exceeds 4
@@ -1180,6 +1224,7 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Writes the central file header entry.
+ *
* @param ze the entry to write
* @param name The encoded name
* @param lfhOffset Local file header offset for this file
@@ -1268,6 +1313,10 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* If the entry needs Zip64 extra information inside the central
* directory then configure its data.
+ *
+ * @param ze ZipEntry
+ * @param lfhOffset long
+ * @param needsZip64Extra boolean
*/
private void handleZip64Extra(ZipEntry ze, long lfhOffset,
boolean needsZip64Extra) {
@@ -1291,6 +1340,7 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Writes the "End of central dir record".
+ *
* @throws IOException on error
* @throws Zip64RequiredException if the archive's size exceeds 4
* GByte or there are more than 65535 entries inside the archive
@@ -1333,6 +1383,7 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Convert a Date object to a DOS date/time field.
+ *
* @param time the <code>Date</code> to convert
* @return the date as a <code>ZipLong</code>
* @since 1.1
@@ -1347,6 +1398,7 @@ public class ZipOutputStream extends FilterOutputStream {
* Convert a Date object to a DOS date/time field.
*
* <p>Stolen from InfoZip's <code>fileio.c</code></p>
+ *
* @param t number of milliseconds since the epoch
* @return the date as a byte array
* @since 1.26
@@ -1360,6 +1412,7 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Retrieve the bytes for the given String in the encoding set for
* this Stream.
+ *
* @param name the string to get bytes from
* @return the bytes as a byte array
* @throws ZipException on error
@@ -1382,6 +1435,7 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Writes the "ZIP64 End of central dir record" and
* "ZIP64 End of central dir locator".
+ *
* @throws IOException on error
*/
protected void writeZip64CentralDirectory() throws IOException {
@@ -1448,6 +1502,7 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Write bytes to output or random access file.
+ *
* @param data the byte array to write
* @throws IOException on error
*
@@ -1459,6 +1514,7 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Write bytes to output or random access file.
+ *
* @param data the byte array to write
* @param offset the start position to write from
* @param length the number of bytes to write
@@ -1478,6 +1534,7 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Assumes a negative integer really is a positive integer that
* has wrapped around and re-creates the original value.
+ *
* @param i the value to treat as unsigned int.
* @return the unsigned int as a long.
* @since 1.34
@@ -1521,6 +1578,9 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Get the existing ZIP64 extended information extra field or
* create a new one and add it to the entry.
+ *
+ * @param ze ZipEntry
+ * @return Zip64ExtendedInformationExtraField
*/
private Zip64ExtendedInformationExtraField getZip64Extra(ZipEntry ze) {
if (entry != null) {
@@ -1550,6 +1610,9 @@ public class ZipOutputStream extends FilterOutputStream {
/**
* Is there a ZIP64 extended information extra field for the
* entry?
+ *
+ * @param ze ZipEntry
+ * @return boolean
*/
private boolean hasZip64Extra(ZipEntry ze) {
return ze.getExtraField(Zip64ExtendedInformationExtraField
@@ -1561,6 +1624,9 @@ public class ZipOutputStream extends FilterOutputStream {
* If the mode is AsNeeded and the entry is a compressed entry of
* unknown size that gets written to a non-seekable stream the
* change the default to Never.
+ *
+ * @param ze ZipEntry
+ * @return Zip64Mode
*/
private Zip64Mode getEffectiveZip64Mode(ZipEntry ze) {
if (zip64Mode != Zip64Mode.AsNeeded
@@ -1588,6 +1654,8 @@ public class ZipOutputStream extends FilterOutputStream {
*
* <p>This method only exists to support tests that generate
* corrupt archives so they can clean up any temporary files.</p>
+ *
+ * @throws IOException if close() fails
*/
void destroy() throws IOException {
if (raf != null) {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/main/org/apache/tools/zip/ZipUtil.java
----------------------------------------------------------------------
diff --git a/src/main/org/apache/tools/zip/ZipUtil.java b/src/main/org/apache/tools/zip/ZipUtil.java
index c25b8c7..9926a29 100644
--- a/src/main/org/apache/tools/zip/ZipUtil.java
+++ b/src/main/org/apache/tools/zip/ZipUtil.java
@@ -34,6 +34,7 @@ public abstract class ZipUtil {
/**
* Convert a Date object to a DOS date/time field.
+ *
* @param time the <code>Date</code> to convert
* @return the date as a <code>ZipLong</code>
*/
@@ -45,6 +46,7 @@ public abstract class ZipUtil {
* Convert a Date object to a DOS date/time field.
*
* <p>Stolen from InfoZip's <code>fileio.c</code></p>
+ *
* @param t number of milliseconds since the epoch
* @return the date as a byte array
*/
@@ -58,6 +60,7 @@ public abstract class ZipUtil {
* Convert a Date object to a DOS date/time field.
*
* <p>Stolen from InfoZip's <code>fileio.c</code></p>
+ *
* @param t number of milliseconds since the epoch
* @param buf the output buffer
* @param offset
@@ -117,6 +120,9 @@ public abstract class ZipUtil {
/**
* Converts DOS time to Java time (number of milliseconds since
* epoch).
+ *
+ * @param dosTime long
+ * @return long
*/
public static long dosToJavaTime(long dosTime) {
Calendar cal = Calendar.getInstance();
@@ -136,6 +142,10 @@ public abstract class ZipUtil {
* If the entry has Unicode*ExtraFields and the CRCs of the
* names/comments match those of the extra fields, transfer the
* known Unicode values from the extra field.
+ *
+ * @param ze ZipEntry
+ * @param originalNameBytes byte[]
+ * @param commentBytes byte[]
*/
static void setNameAndCommentFromExtraFields(ZipEntry ze,
byte[] originalNameBytes,
@@ -166,6 +176,9 @@ public abstract class ZipUtil {
*
* <p>If the field is null or the CRCs don't match, return null
* instead.</p>
+ *
+ * @param f AbstractUnicodeExtraField
+ * @param orig byte[]
*/
private static
String getUnicodeStringIfOriginalMatches(AbstractUnicodeExtraField f,
@@ -194,6 +207,9 @@ public abstract class ZipUtil {
/**
* Create a copy of the given array - or return null if the
* argument is null.
+ *
+ * @param from byte[]
+ * @return byte[]
*/
static byte[] copy(byte[] from) {
if (from != null) {
@@ -206,6 +222,8 @@ public abstract class ZipUtil {
/**
* Whether this library is able to read or write the given entry.
+ *
+ * @return boolean
*/
static boolean canHandleEntryData(ZipEntry entry) {
return supportsEncryptionOf(entry) && supportsMethodOf(entry);
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/antunit/core/uuencode/src/task/BaseTask.java
----------------------------------------------------------------------
diff --git a/src/tests/antunit/core/uuencode/src/task/BaseTask.java b/src/tests/antunit/core/uuencode/src/task/BaseTask.java
index 320f753..70eb7a3 100644
--- a/src/tests/antunit/core/uuencode/src/task/BaseTask.java
+++ b/src/tests/antunit/core/uuencode/src/task/BaseTask.java
@@ -16,6 +16,7 @@
*
*/
package task;
+
import org.apache.tools.ant.Task;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.util.FileUtils;
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/junit/org/apache/tools/ant/BuildFileRule.java
----------------------------------------------------------------------
diff --git a/src/tests/junit/org/apache/tools/ant/BuildFileRule.java b/src/tests/junit/org/apache/tools/ant/BuildFileRule.java
index 52ec877..2611cb2 100644
--- a/src/tests/junit/org/apache/tools/ant/BuildFileRule.java
+++ b/src/tests/junit/org/apache/tools/ant/BuildFileRule.java
@@ -139,7 +139,7 @@ public class BuildFileRule extends ExternalResource {
/**
* Sets up to run the named project
*
- * @param filename name of project file to run
+ * @param filename name of project file to run
*/
public void configureProject(String filename) throws BuildException {
configureProject(filename, Project.MSG_DEBUG);
@@ -148,7 +148,8 @@ public class BuildFileRule extends ExternalResource {
/**
* Sets up to run the named project
*
- * @param filename name of project file to run
+ * @param filename name of project file to run
+ * @param logLevel int
*/
public void configureProject(String filename, int logLevel) throws BuildException {
logBuffer = new StringBuffer();
@@ -167,7 +168,7 @@ public class BuildFileRule extends ExternalResource {
* Executes a target in the configured Ant build file. Requires #configureProject()
* to have been invoked before this call.
*
- * @param targetName the target in the currently configured build file to run.
+ * @param targetName the target in the currently configured build file to run.
*/
public void executeTarget(String targetName) {
outputBuffer = new StringBuffer();
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/junit/org/apache/tools/ant/BuildFileTest.java
----------------------------------------------------------------------
diff --git a/src/tests/junit/org/apache/tools/ant/BuildFileTest.java b/src/tests/junit/org/apache/tools/ant/BuildFileTest.java
index 02b49e3..681cef3 100644
--- a/src/tests/junit/org/apache/tools/ant/BuildFileTest.java
+++ b/src/tests/junit/org/apache/tools/ant/BuildFileTest.java
@@ -103,6 +103,9 @@ public abstract class BuildFileTest extends TestCase {
/**
* Assert that only the given message has been logged with a
* priority <= INFO when running the given target.
+ *
+ * @param target String
+ * @param log String
*/
public void expectLog(String target, String log) {
executeTarget(target);
@@ -112,6 +115,8 @@ public abstract class BuildFileTest extends TestCase {
/**
* Assert that the given substring is in the log messages.
+ *
+ * @param substring String
*/
public void assertLogContaining(String substring) {
String realLog = getLog();
@@ -122,6 +127,8 @@ public abstract class BuildFileTest extends TestCase {
/**
* Assert that the given substring is not in the log messages.
+ *
+ * @param substring String
*/
public void assertLogNotContaining(String substring) {
String realLog = getLog();
@@ -132,6 +139,8 @@ public abstract class BuildFileTest extends TestCase {
/**
* Assert that the given substring is in the output messages.
+ *
+ * @param substring String
* @since Ant1.7
*/
public void assertOutputContaining(String substring) {
@@ -140,8 +149,10 @@ public abstract class BuildFileTest extends TestCase {
/**
* Assert that the given substring is in the output messages.
+ *
* @param message Print this message if the test fails. Defaults to
* a meaningful text if <tt>null</tt> is passed.
+ * @param substring String
* @since Ant1.7
*/
public void assertOutputContaining(String message, String substring) {
@@ -154,8 +165,10 @@ public abstract class BuildFileTest extends TestCase {
/**
* Assert that the given substring is not in the output messages.
+ *
* @param message Print this message if the test fails. Defaults to
* a meaningful text if <tt>null</tt> is passed.
+ * @param substring String
* @since Ant1.7
*/
public void assertOutputNotContaining(String message, String substring) {
@@ -169,6 +182,9 @@ public abstract class BuildFileTest extends TestCase {
/**
* Assert that the given message has been logged with a priority <= INFO when running the
* given target.
+ *
+ * @param target String
+ * @param log String
*/
public void expectLogContaining(String target, String log) {
executeTarget(target);
@@ -178,6 +194,9 @@ public abstract class BuildFileTest extends TestCase {
/**
* Assert that the given message has not been logged with a
* priority <= INFO when running the given target.
+ *
+ * @param target String
+ * @param log String
*/
public void expectLogNotContaining(String target, String log) {
executeTarget(target);
@@ -189,7 +208,7 @@ public abstract class BuildFileTest extends TestCase {
* Only valid if configureProject() has been called.
*
* @pre logBuffer!=null
- * @return The log value
+ * @return The log value
*/
public String getLog() {
return logBuffer.toString();
@@ -198,6 +217,9 @@ public abstract class BuildFileTest extends TestCase {
/**
* Assert that the given message has been logged with a priority
* >= VERBOSE when running the given target.
+ *
+ * @param target String
+ * @param log String
*/
public void expectDebuglog(String target, String log) {
executeTarget(target);
@@ -207,6 +229,8 @@ public abstract class BuildFileTest extends TestCase {
/**
* Assert that the given substring is in the log messages.
+ *
+ * @param substring String
*/
public void assertDebuglogContaining(String substring) {
String realLog = getFullLog();
@@ -231,8 +255,8 @@ public abstract class BuildFileTest extends TestCase {
/**
* execute the target, verify output matches expectations
*
- * @param target target to execute
- * @param output output to look for
+ * @param target target to execute
+ * @param output output to look for
*/
public void expectOutput(String target, String output) {
executeTarget(target);
@@ -244,9 +268,9 @@ public abstract class BuildFileTest extends TestCase {
* Executes the target, verify output matches expectations
* and that we got the named error at the end
*
- * @param target target to execute
- * @param output output to look for
- * @param error Description of Parameter
+ * @param target target to execute
+ * @param output output to look for
+ * @param error Description of Parameter
*/
public void expectOutputAndError(String target, String output, String error) {
executeTarget(target);
@@ -282,7 +306,7 @@ public abstract class BuildFileTest extends TestCase {
/**
* Sets up to run the named project
*
- * @param filename name of project file to run
+ * @param filename name of project file to run
*/
public void configureProject(String filename) throws BuildException {
configureProject(filename, Project.MSG_DEBUG);
@@ -291,7 +315,8 @@ public abstract class BuildFileTest extends TestCase {
/**
* Sets up to run the named project
*
- * @param filename name of project file to run
+ * @param filename name of project file to run
+ * @param logLevel int
*/
public void configureProject(String filename, int logLevel)
throws BuildException {
@@ -312,7 +337,7 @@ public abstract class BuildFileTest extends TestCase {
* Executes a target we have set up
*
* @pre configureProject has been called
- * @param targetName target to run
+ * @param targetName target to run
*/
public void executeTarget(String targetName) {
PrintStream sysOut = System.out;
@@ -367,10 +392,10 @@ public abstract class BuildFileTest extends TestCase {
/**
* Runs a target, wait for a build exception.
*
- * @param target target to run
- * @param cause information string to reader of report
- * @param msg the message value of the build exception we are waiting
- * for set to null for any build exception to be valid
+ * @param target target to run
+ * @param cause information string to reader of report
+ * @param msg the message value of the build exception we are waiting
+ * for set to null for any build exception to be valid
*/
public void expectSpecificBuildException(String target, String cause, String msg) {
try {
@@ -391,9 +416,9 @@ public abstract class BuildFileTest extends TestCase {
* run a target, expect an exception string
* containing the substring we look for (case sensitive match)
*
- * @param target target to run
- * @param cause information string to reader of report
- * @param contains substring of the build exception to look for
+ * @param target target to run
+ * @param cause information string to reader of report
+ * @param contains substring of the build exception to look for
*/
public void expectBuildExceptionContaining(String target, String cause, String contains) {
try {
@@ -479,7 +504,7 @@ public abstract class BuildFileTest extends TestCase {
* relative to the package name or absolute from the root path.
*
* @param resource the resource to retrieve its url.
- * @throws junit.framework.AssertionFailedError if the resource is not found.
+ * @return URL ditto
*/
public URL getResource(String resource) {
URL url = getClass().getResource(resource);
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/junit/org/apache/tools/ant/ImmutableTest.java
----------------------------------------------------------------------
diff --git a/src/tests/junit/org/apache/tools/ant/ImmutableTest.java b/src/tests/junit/org/apache/tools/ant/ImmutableTest.java
index cd65a5a..933bd28 100644
--- a/src/tests/junit/org/apache/tools/ant/ImmutableTest.java
+++ b/src/tests/junit/org/apache/tools/ant/ImmutableTest.java
@@ -65,6 +65,7 @@ public class ImmutableTest {
buildRule.executeTarget("test4");
assertEquals("original", buildRule.getProject().getProperty("test"));
}
+
// ensure <checksum> follows the immutability rule
@Test
public void test5() {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/junit/org/apache/tools/ant/PropertyExpansionTest.java
----------------------------------------------------------------------
diff --git a/src/tests/junit/org/apache/tools/ant/PropertyExpansionTest.java b/src/tests/junit/org/apache/tools/ant/PropertyExpansionTest.java
index 4ac8c5f..601391e 100644
--- a/src/tests/junit/org/apache/tools/ant/PropertyExpansionTest.java
+++ b/src/tests/junit/org/apache/tools/ant/PropertyExpansionTest.java
@@ -76,7 +76,7 @@ public class PropertyExpansionTest {
/**
- * old things we dont want; not a test no more
+ * old things we don't want; not a test anymore
*/
@Test
@Ignore("Previously disabled through naming convention")
@@ -95,5 +95,4 @@ public class PropertyExpansionTest {
assertEquals(source,expected,actual);
}
-//end class
}
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/junit/org/apache/tools/ant/taskdefs/AntTest.java
----------------------------------------------------------------------
diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/AntTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/AntTest.java
index b38857e..1d7c252 100644
--- a/src/tests/junit/org/apache/tools/ant/taskdefs/AntTest.java
+++ b/src/tests/junit/org/apache/tools/ant/taskdefs/AntTest.java
@@ -636,5 +636,4 @@ public class AntTest {
}
-
}
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/junit/org/apache/tools/ant/taskdefs/DeleteTest.java
----------------------------------------------------------------------
diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/DeleteTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/DeleteTest.java
index fb24421..4d34341 100644
--- a/src/tests/junit/org/apache/tools/ant/taskdefs/DeleteTest.java
+++ b/src/tests/junit/org/apache/tools/ant/taskdefs/DeleteTest.java
@@ -52,7 +52,7 @@ public class DeleteTest {
public void test2() {
buildRule.executeTarget("test2");
}
-//where oh where has my test case 3 gone?
+ //where oh where has my test case 3 gone?
@Test
public void test4() {
buildRule.executeTarget("test4");
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/junit/org/apache/tools/ant/taskdefs/MacroDefTest.java
----------------------------------------------------------------------
diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/MacroDefTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/MacroDefTest.java
index ebcd015..9ee7b20 100644
--- a/src/tests/junit/org/apache/tools/ant/taskdefs/MacroDefTest.java
+++ b/src/tests/junit/org/apache/tools/ant/taskdefs/MacroDefTest.java
@@ -132,26 +132,31 @@ public class MacroDefTest {
//TODO assert value
}
}
+
@Test
public void testEscape() {
buildRule.executeTarget("escape");
assertEquals("a@b or a@b is avalue@bvalue", buildRule.getLog());
}
+
@Test
public void testAttributeDescription() {
buildRule.executeTarget("attribute.description");
assertEquals("description is hello world", buildRule.getLog());
}
+
@Test
public void testOverrideDefault() {
buildRule.executeTarget("override.default");
assertEquals("value is new", buildRule.getLog());
}
+
@Test
public void testImplicit() {
buildRule.executeTarget("implicit");
assertEquals("Before implicitIn implicitAfter implicit", buildRule.getLog());
}
+
@Test
public void testImplicitNotOptional() {
try {
@@ -161,11 +166,13 @@ public class MacroDefTest {
assertEquals("Missing nested elements for implicit element implicit", ex.getMessage());
}
}
+
@Test
public void testImplicitOptional() {
buildRule.executeTarget("implicit.optional");
assertEquals("Before implicitAfter implicit", buildRule.getLog());
}
+
@Test
public void testImplicitExplicit() {
try {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/junit/org/apache/tools/ant/taskdefs/ManifestClassPathTest.java
----------------------------------------------------------------------
diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/ManifestClassPathTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/ManifestClassPathTest.java
index 6fb3d13..7f78b7b 100644
--- a/src/tests/junit/org/apache/tools/ant/taskdefs/ManifestClassPathTest.java
+++ b/src/tests/junit/org/apache/tools/ant/taskdefs/ManifestClassPathTest.java
@@ -191,7 +191,6 @@ public class ManifestClassPathTest {
buildRule.executeTarget("international-german");
buildRule.executeTarget("run-two-jars");
assertContains("beta alpha", buildRule.getLog());
-
}
@Test
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/junit/org/apache/tools/ant/taskdefs/ParallelTest.java
----------------------------------------------------------------------
diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/ParallelTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/ParallelTest.java
index 97667e4..4f7a4d0 100644
--- a/src/tests/junit/org/apache/tools/ant/taskdefs/ParallelTest.java
+++ b/src/tests/junit/org/apache/tools/ant/taskdefs/ParallelTest.java
@@ -92,10 +92,10 @@ public class ParallelTest {
/**
* the test result string should match the regex
- * <code>^(\|\d+\/(+-)*)+\|$</code> for someting like
+ * <code>^(\|\d+\/(+-)*)+\|$</code> for something like
* <code>|3/++--+-|5/+++++-----|</code>
*
- *@return -1 no more tests
+ * @return -1 no more tests
* # start pos of next test
*/
static int countThreads(String s, int start) {
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/junit/org/apache/tools/ant/taskdefs/RenameTest.java
----------------------------------------------------------------------
diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/RenameTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/RenameTest.java
index 0cb1344..ca37799 100644
--- a/src/tests/junit/org/apache/tools/ant/taskdefs/RenameTest.java
+++ b/src/tests/junit/org/apache/tools/ant/taskdefs/RenameTest.java
@@ -80,6 +80,7 @@ public class RenameTest {
public void test5() {
buildRule.executeTarget("test5");
}
+
@Test
public void test6() {
buildRule.executeTarget("test6");
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/junit/org/apache/tools/ant/taskdefs/RmicAdvancedTest.java
----------------------------------------------------------------------
diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/RmicAdvancedTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/RmicAdvancedTest.java
index 3bbef0e..3113af5 100644
--- a/src/tests/junit/org/apache/tools/ant/taskdefs/RmicAdvancedTest.java
+++ b/src/tests/junit/org/apache/tools/ant/taskdefs/RmicAdvancedTest.java
@@ -227,7 +227,6 @@ public class RmicAdvancedTest {
}
}
-
/**
* A unit test for JUnit
*/
@@ -243,7 +242,6 @@ public class RmicAdvancedTest {
AntAssert.assertContains("unimplemented.class", buildRule.getLog());
}
-
/**
* A unit test for JUnit
*/
@@ -270,13 +268,11 @@ public class RmicAdvancedTest {
}
}
-
@Test
public void testMagicPropertyIsEmptyString() throws Exception {
buildRule.executeTarget("testMagicPropertyIsEmptyString");
}
-
@Test
@Ignore("Previously named to prevent execution")
public void NotestFailingAdapter() throws Exception {
@@ -288,7 +284,6 @@ public class RmicAdvancedTest {
}
}
-
/**
* test that version 1.1 stubs are good
* @throws Exception if something goes wrong
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/junit/org/apache/tools/ant/taskdefs/SQLExecTest.java
----------------------------------------------------------------------
diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/SQLExecTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/SQLExecTest.java
index dac6941..979ec23 100644
--- a/src/tests/junit/org/apache/tools/ant/taskdefs/SQLExecTest.java
+++ b/src/tests/junit/org/apache/tools/ant/taskdefs/SQLExecTest.java
@@ -179,6 +179,8 @@ public class SQLExecTest {
* If you want to test on your specific base, you'd better
* tweak this to make it run or add your own database.
* The driver lib should be dropped into the system classloader.
+ *
+ * @param database int
*/
protected Properties getProperties(int database) {
Properties props = null;
@@ -200,7 +202,14 @@ public class SQLExecTest {
return props;
}
- /** helper method to build properties */
+ /**
+ * helper method to build properties
+ *
+ * @param driver String
+ * @param user String
+ * @param pwd String
+ * @param url String
+ */
protected Properties getProperties(String driver, String user, String pwd, String url) {
Properties props = new Properties();
props.put(DRIVER, driver);
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/junit/org/apache/tools/ant/taskdefs/condition/TypeFoundTest.java
----------------------------------------------------------------------
diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/condition/TypeFoundTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/condition/TypeFoundTest.java
index ab28494..6c73188 100644
--- a/src/tests/junit/org/apache/tools/ant/taskdefs/condition/TypeFoundTest.java
+++ b/src/tests/junit/org/apache/tools/ant/taskdefs/condition/TypeFoundTest.java
@@ -87,5 +87,4 @@ public class TypeFoundTest {
assertEquals("true", buildRule.getProject().getProperty("testMacro"));
}
-
}
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/junit/org/apache/tools/ant/taskdefs/optional/AbstractXSLTLiaisonTest.java
----------------------------------------------------------------------
diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/AbstractXSLTLiaisonTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/AbstractXSLTLiaisonTest.java
index d7dedfc..9a77203 100644
--- a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/AbstractXSLTLiaisonTest.java
+++ b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/AbstractXSLTLiaisonTest.java
@@ -53,7 +53,13 @@ public abstract class AbstractXSLTLiaisonTest {
// to override
protected abstract XSLTLiaison createLiaison() throws Exception;
- /** load the file from the caller classloader that loaded this class */
+ /**
+ * Load the file from the caller classloader that loaded this class
+ *
+ * @param name String
+ * @return File
+ * @throws FileNotFoundException if file is not found
+ */
protected File getFile(String name) throws FileNotFoundException {
URL url = getClass().getResource(name);
if (url == null) {
@@ -62,7 +68,11 @@ public abstract class AbstractXSLTLiaisonTest {
return new File(FILE_UTILS.fromURI(url.toExternalForm()));
}
- /** keep it simple stupid */
+ /**
+ * Keep it simple stupid
+ *
+ * @throws Exception if something goes wrong
+ */
@Test
public void testTransform() throws Exception {
File xsl = getFile("/taskdefs/optional/xsltliaison-in.xsl");
http://git-wip-us.apache.org/repos/asf/ant/blob/6656db28/src/tests/junit/org/apache/tools/ant/taskdefs/optional/TraXLiaisonTest.java
----------------------------------------------------------------------
diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/TraXLiaisonTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/TraXLiaisonTest.java
index d11893a..c4f28ab 100644
--- a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/TraXLiaisonTest.java
+++ b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/TraXLiaisonTest.java
@@ -27,8 +27,6 @@ import java.security.Permission;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.TransformerFactoryConfigurationError;
-import junit.framework.AssertionFailedError;
-
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.taskdefs.XSLTLiaison;
import org.apache.tools.ant.taskdefs.XSLTLogger;
@@ -170,7 +168,7 @@ public class TraXLiaisonTest extends AbstractXSLTLiaisonTest
}
public void log(String message) {
- throw new AssertionFailedError("Liaison sent message: " + message);
+ throw new AssertionError("Liaison sent message: " + message);
}
}