Annotate with @OverRide and @deprecated.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1087901 13f79535-47bb-0310-9956-ffa450edef68

Author: garydgregory

pom.xml

@@ -265,6 +265,9 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-pmd-plugin</artifactId>
         <version>2.5</version>
+        <configuration>
+          <targetJdk>1.5</targetJdk>      
+        </configuration>
       </plugin>
       <plugin>
         <groupId>org.codehaus.mojo</groupId>

src/java/org/apache/commons/codec/StringEncoderComparator.java

@@ -40,6 +40,7 @@ public class StringEncoderComparator implements Comparator {
      * @deprecated Creating an instance without a {@link StringEncoder} leads to a {@link NullPointerException}. Will be
      *             removed in 2.0.
      */
+    @Deprecated
     public StringEncoderComparator() {
         this.stringEncoder = null; // Trying to use this will cause things to break
     }

src/java/org/apache/commons/codec/binary/Base32.java

@@ -278,6 +278,7 @@ public Base32(int lineLength, byte[] lineSeparator, boolean useHex) {
      *
      * Output is written to {@link #buffer} as 8-bit octets, using {@link #pos} as the buffer position
      */
+    @Override
     void decode(byte[] in, int inPos, int inAvail) { // package protected for access from I/O streams
         if (eof) {
             return;
@@ -366,6 +367,7 @@ void decode(byte[] in, int inPos, int inAvail) { // package protected for access
      * @param inAvail
      *            Amount of bytes available from input for encoding.
      */
+    @Override
     void encode(byte[] in, int inPos, int inAvail) { // package protected for access from I/O streams
         if (eof) {
             return;
@@ -464,6 +466,7 @@ void encode(byte[] in, int inPos, int inAvail) { // package protected for access
      *            The value to test
      * @return <code>true</code> if the value is defined in the the Base32 alphabet <code>false</code> otherwise.
      */
+    @Override
     public boolean isInAlphabet(byte octet) {
         return octet >= 0 && octet < decodeTable.length && decodeTable[octet] != -1;
     }

src/java/org/apache/commons/codec/binary/Base64.java

@@ -323,6 +323,7 @@ public boolean isUrlSafe() {
      * @param inAvail
      *            Amount of bytes available from input for encoding.
      */
+    @Override
     void encode(byte[] in, int inPos, int inAvail) {
         if (eof) {
             return;
@@ -411,6 +412,7 @@ void encode(byte[] in, int inPos, int inAvail) {
      * @param inAvail
      *            Amount of bytes available from input for encoding.
      */
+    @Override
     void decode(byte[] in, int inPos, int inAvail) {
         if (eof) {
             return;
@@ -501,6 +503,7 @@ public static boolean isBase64(String base64) {
      *         <code>false</code>, otherwise
      * @deprecated 1.5 Use {@link #isBase64(byte[])}, will be removed in 2.0.
      */
+    @Deprecated
     public static boolean isArrayByteBase64(byte[] arrayOctet) {
         return isBase64(arrayOctet);
     }
@@ -748,6 +751,7 @@ static byte[] toIntegerBytes(BigInteger bigInt) {
      *            The value to test
      * @return <code>true</code> if the value is defined in the the Base32 alphabet <code>false</code> otherwise.
      */
+    @Override
     protected boolean isInAlphabet(byte octet) {
         return octet >= 0 && octet < decodeTable.length && decodeTable[octet] != -1;
     }

src/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java

@@ -47,6 +47,7 @@ protected BaseNCodecInputStream(InputStream in, BaseNCodec baseNCodec, boolean d
      * @throws IOException
      *             if an I/O error occurs.
      */
+    @Override
     public int read() throws IOException {
         int r = read(singleByte, 0, 1);
         while (r == 0) {
@@ -77,6 +78,7 @@ public int read() throws IOException {
      * @throws IndexOutOfBoundsException
      *             if offset, len or buffer size are invalid
      */
+    @Override
     public int read(byte b[], int offset, int len) throws IOException {
         if (b == null) {
             throw new NullPointerException();
@@ -124,6 +126,7 @@ public int read(byte b[], int offset, int len) throws IOException {
      * 
      * @return false
      */
+    @Override
     public boolean markSupported() {
         return false; // not an easy job to support marks
     }

src/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java

@@ -48,6 +48,7 @@ public BaseNCodecOutputStream(OutputStream out, BaseNCodec basedCodec, boolean d
      * @throws IOException
      *             if an I/O error occurs.
      */
+    @Override
     public void write(int i) throws IOException {
         singleByte[0] = (byte) i;
         write(singleByte, 0, 1);
@@ -71,6 +72,7 @@ public void write(int i) throws IOException {
      * @throws IndexOutOfBoundsException
      *             if offset, len or buffer size are invalid
      */
+    @Override
     public void write(byte b[], int offset, int len) throws IOException {
         if (b == null) {
             throw new NullPointerException();
@@ -117,6 +119,7 @@ private void flush(boolean propogate) throws IOException {
      * @throws IOException
      *             if an I/O error occurs.
      */
+    @Override
     public void flush() throws IOException {
         flush(true);
     }
@@ -127,6 +130,7 @@ public void flush() throws IOException {
      * @throws IOException
      *             if an I/O error occurs.
      */
+    @Override
     public void close() throws IOException {
         // Notify encoder of EOF (-1).
         if (doEncode) {

src/java/org/apache/commons/codec/binary/Hex.java

@@ -295,6 +295,7 @@ public String getCharsetName() {
      * 
      * @return a string representation of the object.
      */
+    @Override
     public String toString() {
         return super.toString() + "[charsetName=" + this.charsetName + "]";
     }

src/java/org/apache/commons/codec/language/Caverphone.java

@@ -33,6 +33,7 @@
  * @since 1.4
  * @deprecated 1.5 Replaced by {@link Caverphone2}, will be removed in 2.0.
  */
+@Deprecated
 public class Caverphone implements StringEncoder {
 
     /**

src/java/org/apache/commons/codec/language/ColognePhonetic.java

@@ -27,12 +27,12 @@
  * Encodes a string into a Cologne Phonetic value.
  * </p>
  * <p>
- * Implements the <a href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik">“Kölner Phonetic”</a> (Cologne Phonetic)
+ * Implements the <a href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik">“Kölner Phonetic�</a> (Cologne Phonetic)
  * algorithm issued by Hans Joachim Postel in 1969.
  * </p>
  * 
  * <p>
- * The <i>Kölner Phonetik</i> is a phonetic algorithm which is optimized for the German language. It is related to the
+ * The <i>Kölner Phonetik</i> is a phonetic algorithm which is optimized for the German language. It is related to the
  * well-known soundex algorithm.
  * </p>
  * 
@@ -151,12 +151,12 @@
  * </table>
  * <p>
  * <small><i>(Source: <a href= "http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik#Buchstabencodes" >Wikipedia (de):
- * Kölner Phonetik – Buchstabencodes</a>)</i></small>
+ * Kölner Phonetik – Buchstabencodes</a>)</i></small>
  * </p>
  * 
  * <h4>Example:</h4>
  * 
- * {@code "Müller-Lüdenscheidt" => "MULLERLUDENSCHEIDT" => "6005507500206880022"}
+ * {@code "Müller-Lüdenscheidt" => "MULLERLUDENSCHEIDT" => "6005507500206880022"}
  * 
  * </li>
  * 
@@ -168,15 +168,15 @@
  * 
  * <li>
  * <h3>Step 3:</h3>
- * Removal of all codes “0” except at the beginning. This means that two or more identical consecutive digits can occur
+ * Removal of all codes “0� except at the beginning. This means that two or more identical consecutive digits can occur
  * if they occur after removing the "0" digits.
  * 
  * <h4>Example:</h4>
  * {@code "6050750206802" => "65752682"}</li>
  * 
  * </ul>
  * 
- * @see <a href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik">Wikipedia (de): Kölner Phonetik (in German)</a>
+ * @see <a href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik">Wikipedia (de): Kölner Phonetik (in German)</a>
  * @author Apache Software Foundation
  * @since 1.5
  */
@@ -204,6 +204,7 @@ public int length() {
             return length;
         }
 
+        @Override
         public String toString() {
             return new String(copyData(0, length));
         }
@@ -220,6 +221,7 @@ public void addRight(char chr) {
             length++;
         }
 
+        @Override
         protected char[] copyData(int start, final int length) {
             char[] newData = new char[length];
             System.arraycopy(data, start, newData, 0, length);
@@ -238,6 +240,7 @@ public void addLeft(char ch) {
             data[getNextPos()] = ch;
         }
 
+        @Override
         protected char[] copyData(int start, final int length) {
             char[] newData = new char[length];
             System.arraycopy(data, data.length - this.length + start, newData, 0, length);
@@ -259,10 +262,10 @@ public char removeNext() {
         }
     }
 
-    private static final char[][] PREPROCESS_MAP = new char[][]{{'\u00C4', 'A'}, // Ä
-        {'\u00DC', 'U'}, // Ü
-        {'\u00D6', 'O'}, // Ö
-        {'\u00DF', 'S'} // ß
+    private static final char[][] PREPROCESS_MAP = new char[][]{{'\u00C4', 'A'}, // Ä
+        {'\u00DC', 'U'}, // Ü
+        {'\u00D6', 'O'}, // Ö
+        {'\u00DF', 'S'} // ß
     };
 
     /*
@@ -279,14 +282,14 @@ private static boolean arrayContains(char[] arr, char key) {
 
     /**
      * <p>
-     * <b>colognePhonetic()</b> is the actual implementations of the <i>Kölner Phonetik</i> algorithm.
+     * <b>colognePhonetic()</b> is the actual implementations of the <i>Kölner Phonetik</i> algorithm.
      * </p>
      * <p>
      * In contrast to the initial description of the algorithm, this implementation does the encoding in one pass.
      * </p>
      * 
      * @param text
-     * @return the corresponding encoding according to the <i>Kölner Phonetik</i> algorithm
+     * @return the corresponding encoding according to the <i>Kölner Phonetik</i> algorithm
      */
     public String colognePhonetic(String text) {
         if (text == null) {
@@ -376,7 +379,7 @@ public String colognePhonetic(String text) {
 
     public Object encode(Object object) throws EncoderException {
         if (!(object instanceof String)) {
-            throw new EncoderException("This method’s parameter was expected to be of the type " +
+            throw new EncoderException("This method’s parameter was expected to be of the type " +
                 String.class.getName() +
                 ". But actually it was of the type " +
                 object.getClass().getName() +
@@ -394,7 +397,7 @@ public boolean isEncodeEqual(String text1, String text2) {
     }
 
     /*
-     * Converts the string to upper case and replaces germanic umlauts, and the “ß”.
+     * Converts the string to upper case and replaces germanic umlauts, and the “ß�.
      */
     private String preprocess(String text) {
         text = text.toUpperCase(Locale.GERMAN);

src/java/org/apache/commons/codec/language/Soundex.java

@@ -85,6 +85,7 @@ public int difference(String s1, String s2) throws EncoderException {
      * 
      * @deprecated This feature is not needed since the encoding size must be constant. Will be removed in 2.0.
      */
+    @Deprecated
     private int maxLength = 4;
 
     /**
@@ -199,6 +200,7 @@ private char getMappingCode(String str, int index) {
      * @deprecated This feature is not needed since the encoding size must be constant. Will be removed in 2.0.
      * @return int
      */
+    @Deprecated
     public int getMaxLength() {
         return this.maxLength;
     }
@@ -236,6 +238,7 @@ private char map(char ch) {
      * @param maxLength
      *                  The maxLength to set
      */
+    @Deprecated
     public void setMaxLength(int maxLength) {
         this.maxLength = maxLength;
     }