You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2012/04/01 00:40:48 UTC
svn commit: r1307928 - in /commons/proper/compress/trunk/src:
main/java/org/apache/commons/compress/archivers/
main/java/org/apache/commons/compress/archivers/tar/
main/java/org/apache/commons/compress/archivers/zip/
main/java/org/apache/commons/compre...
Author: ggregory
Date: Sat Mar 31 22:40:47 2012
New Revision: 1307928
URL: http://svn.apache.org/viewvc?rev=1307928&view=rev
Log:
Replace Javadoc "<code>null|true|false</code>" with "{@code null|true|false}"
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/FallbackZipEncoding.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/Simple8BitZipEncoding.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncodingHelper.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/FileNameUtil.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Utils.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/ArchiveUtils.java
commons/proper/compress/trunk/src/test/java/org/apache/commons/compress/AbstractTestCase.java
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java?rev=1307928&r1=1307927&r2=1307928&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java Sat Mar 31 22:40:47 2012
@@ -49,7 +49,7 @@ public abstract class ArchiveInputStream
* Returns the next Archive Entry in this Stream.
*
* @return the next entry,
- * or <code>null</code> if there are no more entries
+ * or {@code null} if there are no more entries
* @throws IOException if the next entry could not be read
*/
public abstract ArchiveEntry getNextEntry() throws IOException;
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java?rev=1307928&r1=1307927&r2=1307928&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java Sat Mar 31 22:40:47 2012
@@ -681,7 +681,7 @@ public class TarArchiveEntry implements
/**
* Check if this is a Pax header.
*
- * @return <code>true</code> if this is a Pax header.
+ * @return {@code true} if this is a Pax header.
*
* @since Apache Commons Compress 1.1
*/
@@ -693,7 +693,7 @@ public class TarArchiveEntry implements
/**
* Check if this is a Pax header.
*
- * @return <code>true</code> if this is a Pax header.
+ * @return {@code true} if this is a Pax header.
*
* @since Apache Commons Compress 1.1
*/
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/FallbackZipEncoding.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/FallbackZipEncoding.java?rev=1307928&r1=1307927&r2=1307928&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/FallbackZipEncoding.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/FallbackZipEncoding.java Sat Mar 31 22:40:47 2012
@@ -54,7 +54,7 @@ class FallbackZipEncoding implements Zip
/**
* Construct a fallback zip encoding, which uses the given charset.
*
- * @param charset The name of the charset or <code>null</code> for
+ * @param charset The name of the charset or {@code null} for
* the platform's default character set.
*/
public FallbackZipEncoding(String charset) {
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/Simple8BitZipEncoding.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/Simple8BitZipEncoding.java?rev=1307928&r1=1307927&r2=1307928&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/Simple8BitZipEncoding.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/Simple8BitZipEncoding.java Sat Mar 31 22:40:47 2012
@@ -152,7 +152,7 @@ class Simple8BitZipEncoding implements Z
* @param bb The byte buffer to write to.
* @param c The character to encode.
* @return Whether the given unicode character is covered by this encoding.
- * If <code>false</code> is returned, nothing is pushed to the
+ * If {@code false} is returned, nothing is pushed to the
* byte buffer.
*/
public boolean pushEncodedChar(ByteBuffer bb, char c) {
@@ -173,7 +173,7 @@ class Simple8BitZipEncoding implements Z
/**
* @param c A unicode character in the range from 0x0080 to 0x7f00
* @return A Simple8BitChar, if this character is covered by this encoding.
- * A <code>null</code> value is returned, if this character is not
+ * A {@code null} value is returned, if this character is not
* covered by this encoding.
*/
private Simple8BitChar encodeHighChar(char c) {
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncodingHelper.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncodingHelper.java?rev=1307928&r1=1307927&r2=1307928&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncodingHelper.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncodingHelper.java Sat Mar 31 22:40:47 2012
@@ -205,7 +205,7 @@ public abstract class ZipEncodingHelper
/**
* Instantiates a zip encoding.
*
- * @param name The name of the zip encoding. Specify <code>null</code> for
+ * @param name The name of the zip encoding. Specify {@code null} for
* the platform's default encoding.
* @return A zip encoding for the given encoding name.
*/
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java?rev=1307928&r1=1307927&r2=1307928&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java Sat Mar 31 22:40:47 2012
@@ -285,11 +285,11 @@ public class ZipFile {
}
/**
- * Returns a named entry - or <code>null</code> if no entry by
+ * Returns a named entry - or {@code null} if no entry by
* that name exists.
* @param name name of the entry.
* @return the ZipArchiveEntry corresponding to the given name - or
- * <code>null</code> if not present.
+ * {@code null} if not present.
*/
public ZipArchiveEntry getEntry(String name) {
return nameMap.get(name);
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/FileNameUtil.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/FileNameUtil.java?rev=1307928&r1=1307927&r2=1307928&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/FileNameUtil.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/FileNameUtil.java Sat Mar 31 22:40:47 2012
@@ -127,8 +127,8 @@ public class FileNameUtil {
* Detects common format suffixes in the given filename.
*
* @param filename name of a file
- * @return <code>true</code> if the filename has a common format suffix,
- * <code>false</code> otherwise
+ * @return {@code true} if the filename has a common format suffix,
+ * {@code false} otherwise
*/
public boolean isCompressedFilename(String filename) {
final String lower = filename.toLowerCase(Locale.ENGLISH);
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Utils.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Utils.java?rev=1307928&r1=1307927&r2=1307928&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Utils.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Utils.java Sat Mar 31 22:40:47 2012
@@ -52,8 +52,8 @@ public abstract class BZip2Utils {
* Detects common bzip2 suffixes in the given filename.
*
* @param filename name of a file
- * @return <code>true</code> if the filename has a common bzip2 suffix,
- * <code>false</code> otherwise
+ * @return {@code true} if the filename has a common bzip2 suffix,
+ * {@code false} otherwise
*/
public static boolean isCompressedFilename(String filename) {
return fileNameUtil.isCompressedFilename(filename);
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java?rev=1307928&r1=1307927&r2=1307928&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java Sat Mar 31 22:40:47 2012
@@ -98,7 +98,7 @@ public class GzipCompressorInputStream e
* Constructs a new input stream that decompresses gzip-compressed data
* from the specified input stream.
* <p>
- * If <code>decompressConcatenated</code> is <code>false</code>:
+ * If <code>decompressConcatenated</code> is {@code false}:
* This decompressor might read more input than it will actually use.
* If <code>inputStream</code> supports <code>mark</code> and
* <code>reset</code>, then the input position will be adjusted
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java?rev=1307928&r1=1307927&r2=1307928&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java Sat Mar 31 22:40:47 2012
@@ -58,8 +58,8 @@ public class GzipUtils {
* Detects common gzip suffixes in the given filename.
*
* @param filename name of a file
- * @return <code>true</code> if the filename has a common gzip suffix,
- * <code>false</code> otherwise
+ * @return {@code true} if the filename has a common gzip suffix,
+ * {@code false} otherwise
*/
public static boolean isCompressedFilename(String filename) {
return fileNameUtil.isCompressedFilename(filename);
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java?rev=1307928&r1=1307927&r2=1307928&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java Sat Mar 31 22:40:47 2012
@@ -47,8 +47,8 @@ public class XZUtils {
* Detects common xz suffixes in the given filename.
*
* @param filename name of a file
- * @return <code>true</code> if the filename has a common xz suffix,
- * <code>false</code> otherwise
+ * @return {@code true} if the filename has a common xz suffix,
+ * {@code false} otherwise
*/
public static boolean isCompressedFilename(String filename) {
return fileNameUtil.isCompressedFilename(filename);
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/ArchiveUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/ArchiveUtils.java?rev=1307928&r1=1307927&r2=1307928&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/ArchiveUtils.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/ArchiveUtils.java Sat Mar 31 22:40:47 2012
@@ -61,7 +61,7 @@ public class ArchiveUtils {
* @param buffer
* @param offset
* @param length
- * @return <code>true</code> if buffer is the same as the expected string
+ * @return {@code true} if buffer is the same as the expected string
*/
public static boolean matchAsciiBuffer(
String expected, byte[] buffer, int offset, int length){
@@ -79,7 +79,7 @@ public class ArchiveUtils {
*
* @param expected
* @param buffer
- * @return <code>true</code> if buffer is the same as the expected string
+ * @return {@code true} if buffer is the same as the expected string
*/
public static boolean matchAsciiBuffer(String expected, byte[] buffer){
return matchAsciiBuffer(expected, buffer, 0, buffer.length);
@@ -140,7 +140,7 @@ public class ArchiveUtils {
* @param offset2
* @param length2
* @param ignoreTrailingNulls
- * @return <code>true</code> if buffer1 and buffer2 have same contents, having regard to trailing nulls
+ * @return {@code true} if buffer1 and buffer2 have same contents, having regard to trailing nulls
*/
public static boolean isEqual(
final byte[] buffer1, final int offset1, final int length1,
@@ -183,7 +183,7 @@ public class ArchiveUtils {
* @param buffer2
* @param offset2
* @param length2
- * @return <code>true</code> if buffer1 and buffer2 have same contents
+ * @return {@code true} if buffer1 and buffer2 have same contents
*/
public static boolean isEqual(
final byte[] buffer1, final int offset1, final int length1,
@@ -196,7 +196,7 @@ public class ArchiveUtils {
*
* @param buffer1
* @param buffer2
- * @return <code>true</code> if buffer1 and buffer2 have same contents
+ * @return {@code true} if buffer1 and buffer2 have same contents
*/
public static boolean isEqual(final byte[] buffer1, final byte[] buffer2 ){
return isEqual(buffer1, 0, buffer1.length, buffer2, 0, buffer2.length, false);
@@ -208,7 +208,7 @@ public class ArchiveUtils {
* @param buffer1
* @param buffer2
* @param ignoreTrailingNulls
- * @return <code>true</code> if buffer1 and buffer2 have same contents
+ * @return {@code true} if buffer1 and buffer2 have same contents
*/
public static boolean isEqual(final byte[] buffer1, final byte[] buffer2, boolean ignoreTrailingNulls){
return isEqual(buffer1, 0, buffer1.length, buffer2, 0, buffer2.length, ignoreTrailingNulls);
@@ -223,7 +223,7 @@ public class ArchiveUtils {
* @param buffer2
* @param offset2
* @param length2
- * @return <code>true</code> if buffer1 and buffer2 have same contents, having regard to trailing nulls
+ * @return {@code true} if buffer1 and buffer2 have same contents, having regard to trailing nulls
*/
public static boolean isEqualWithNull(
final byte[] buffer1, final int offset1, final int length1,
Modified: commons/proper/compress/trunk/src/test/java/org/apache/commons/compress/AbstractTestCase.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/test/java/org/apache/commons/compress/AbstractTestCase.java?rev=1307928&r1=1307927&r2=1307928&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/test/java/org/apache/commons/compress/AbstractTestCase.java (original)
+++ commons/proper/compress/trunk/src/test/java/org/apache/commons/compress/AbstractTestCase.java Sat Mar 31 22:40:47 2012
@@ -293,7 +293,7 @@ public abstract class AbstractTestCase e
* Checks that an archive input stream can be read, and that the file data matches file sizes.
*
* @param in
- * @param expected list of expected entries or <code>null</code> if no check of names desired
+ * @param expected list of expected entries or {@code null} if no check of names desired
* @throws Exception
*/
protected void checkArchiveContent(ArchiveInputStream in, List<String> expected)
@@ -305,7 +305,7 @@ public abstract class AbstractTestCase e
* Checks that an archive input stream can be read, and that the file data matches file sizes.
*
* @param in
- * @param expected list of expected entries or <code>null</code> if no check of names desired
+ * @param expected list of expected entries or {@code null} if no check of names desired
* @param cleanUp Cleans up resources if true
* @return returns the created result file if cleanUp = false, or null otherwise
* @throws Exception