You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2016/08/26 15:07:55 UTC

svn commit: r1757873 - in /directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1: actions/AbstractReadInteger.java ber/Asn1Container.java ber/tlv/BerValue.java ber/tlv/LongDecoder.java ber/tlv/UniversalTag.java

Author: elecharny
Date: Fri Aug 26 15:07:54 2016
New Revision: 1757873

URL: http://svn.apache.org/viewvc?rev=1757873&view=rev
Log:
Fixed Javadoc

Modified:
    directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadInteger.java
    directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/Asn1Container.java
    directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/BerValue.java
    directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/LongDecoder.java
    directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/UniversalTag.java

Modified: directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadInteger.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadInteger.java?rev=1757873&r1=1757872&r2=1757873&view=diff
==============================================================================
--- directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadInteger.java (original)
+++ directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadInteger.java Fri Aug 26 15:07:54 2016
@@ -36,7 +36,7 @@ import org.slf4j.LoggerFactory;
 /**
  * The action used to read an integer value
  *
- * @param C The container type
+ * @param E The container type
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/Asn1Container.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/Asn1Container.java?rev=1757873&r1=1757872&r2=1757873&view=diff
==============================================================================
--- directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/Asn1Container.java (original)
+++ directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/Asn1Container.java Fri Aug 26 15:07:54 2016
@@ -171,7 +171,7 @@ public interface Asn1Container
     /**
      * @param decodedBytes The number of decoded bytes for this message.
      */
-    void setDecodedBytes( int decodeBytes );
+    void setDecodedBytes( int decodedBytes );
 
 
     /**
@@ -199,7 +199,6 @@ public interface Asn1Container
      * Move backward in the stream to the first byte for a given TLV. This is useful when we have
      * read some Tag and Length in order to define the next transition, and if this transition
      * do a grammar switch.
-     * @param tlv The TLV to roll-back
      */
     void rewind();
 

Modified: directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/BerValue.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/BerValue.java?rev=1757873&r1=1757872&r2=1757873&view=diff
==============================================================================
--- directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/BerValue.java (original)
+++ directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/BerValue.java Fri Aug 26 15:07:54 2016
@@ -401,55 +401,55 @@ public class BerValue
      * - [0x800000 - 0xFFFFFF] : 0x00 0xVV 0xVV 0xVV
      * - [0x01000000 - 0x7FFFFFFF] : 0xVV 0xVV 0xVV 0xVV
      * 2) Negative number - (~value) + 1
-     * <pre>
+     * </pre>
      * They are encoded following the table (the <br>
      * encode bytes are those enclosed by squared braquets) :<br>
      * <br>
      * <pre>
-     *   -1                      -> FF FF FF FF FF FF FF [FF]
-     *   -127                    -> FF FF FF FF FF FF FF [81]
-     *   -128                    -> FF FF FF FF FF FF FF [80]
-     *   -129                    -> FF FF FF FF FF FF [FF 7F]
-     *   -255                    -> FF FF FF FF FF FF [FF 01]
-     *   -256                    -> FF FF FF FF FF FF [FF 00]
-     *   -257                    -> FF FF FF FF FF FF [FE FF]
-     *   -32767                  -> FF FF FF FF FF FF [80 01]
-     *   -32768                  -> FF FF FF FF FF FF [80 00]
-     *   -32769                  -> FF FF FF FF FF [FF 7F FF]
-     *   -65535                  -> FF FF FF FF FF [FF 00 01]
-     *   -65536                  -> FF FF FF FF FF [FF 00 00]
-     *   -65537                  -> FF FF FF FF FF [FE FF FF]
-     *   -8388607                -> FF FF FF FF FF [80 00 01]
-     *   -8388608                -> FF FF FF FF FF [80 00 00]
-     *   -8388609                -> FF FF FF FF [FF 7F FF FF]
-     *   -16777215               -> FF FF FF FF [FF 00 00 01]
-     *   -16777216               -> FF FF FF FF [FF 00 00 00]
-     *   -16777217               -> FF FF FF FF [FE FF FF FF]
-     *   -2147483647             -> FF FF FF FF [80 00 00 01]
-     *   -2147483648             -> FF FF FF FF [80 00 00 00]
-     *   -2147483649             -> FF FF FF [FF 7F FF FF FF]
-     *   -4294967295             -> FF FF FF [FF 00 00 00 01]
-     *   -4294967296             -> FF FF FF [FF 00 00 00 00]
-     *   -4294967297             -> FF FF FF [FE FF FF FF FF]
-     *   -549755813887           -> FF FF FF [80 00 00 00 01]
-     *   -549755813888           -> FF FF FF [80 00 00 00 00]
-     *   -549755813889           -> FF FF [FF 7F FF FF FF FF]
-     *   -1099511627775          -> FF FF [FF 00 00 00 00 01]
-     *   -1099511627776          -> FF FF [FF 00 00 00 00 00]
-     *   -1099511627777          -> FF FF [FE FF FF FF FF FF]
-     *   -140737488355327        -> FF FF [80 00 00 00 00 01]
-     *   -140737488355328        -> FF FF [80 00 00 00 00 00]
-     *   -140737488355329        -> FF [FF 7F FF FF FF FF FF]
-     *   -281474976710655        -> FF [FF 00 00 00 00 00 01]
-     *   -281474976710656        -> FF [FF 00 00 00 00 00 00]
-     *   -281474976710657        -> FF [FE FF FF FF FF FF FF]
-     *   -36028797018963967      -> FF [80 00 00 00 00 00 01]
-     *   -36028797018963968      -> FF [80 00 00 00 00 00 00]
-     *   -36028797018963969      -> [FF 7F FF FF FF FF FF FF]
-     *   -72057594037927936      -> [FF 00 00 00 00 00 00 00]
-     *   -72057594037927937      -> [FE FF FF FF FF FF FF FF]
-     *   -9223372036854775807    -> [80 00 00 00 00 00 00 01]
-     *   -9223372036854775808    -> [80 00 00 00 00 00 00 00]
+     *   -1                      -&gt; FF FF FF FF FF FF FF [FF]
+     *   -127                    -&gt; FF FF FF FF FF FF FF [81]
+     *   -128                    -&gt; FF FF FF FF FF FF FF [80]
+     *   -129                    -&gt; FF FF FF FF FF FF [FF 7F]
+     *   -255                    -&gt; FF FF FF FF FF FF [FF 01]
+     *   -256                    -&gt; FF FF FF FF FF FF [FF 00]
+     *   -257                    -&gt; FF FF FF FF FF FF [FE FF]
+     *   -32767                  -&gt; FF FF FF FF FF FF [80 01]
+     *   -32768                  -&gt; FF FF FF FF FF FF [80 00]
+     *   -32769                  -&gt; FF FF FF FF FF [FF 7F FF]
+     *   -65535                  -&gt; FF FF FF FF FF [FF 00 01]
+     *   -65536                  -&gt; FF FF FF FF FF [FF 00 00]
+     *   -65537                  -&gt; FF FF FF FF FF [FE FF FF]
+     *   -8388607                -&gt; FF FF FF FF FF [80 00 01]
+     *   -8388608                -&gt; FF FF FF FF FF [80 00 00]
+     *   -8388609                -&gt; FF FF FF FF [FF 7F FF FF]
+     *   -16777215               -&gt; FF FF FF FF [FF 00 00 01]
+     *   -16777216               -&gt; FF FF FF FF [FF 00 00 00]
+     *   -16777217               -&gt; FF FF FF FF [FE FF FF FF]
+     *   -2147483647             -&gt; FF FF FF FF [80 00 00 01]
+     *   -2147483648             -&gt; FF FF FF FF [80 00 00 00]
+     *   -2147483649             -&gt; FF FF FF [FF 7F FF FF FF]
+     *   -4294967295             -&gt; FF FF FF [FF 00 00 00 01]
+     *   -4294967296             -&gt; FF FF FF [FF 00 00 00 00]
+     *   -4294967297             -&gt; FF FF FF [FE FF FF FF FF]
+     *   -549755813887           -&gt; FF FF FF [80 00 00 00 01]
+     *   -549755813888           -&gt; FF FF FF [80 00 00 00 00]
+     *   -549755813889           -&gt; FF FF [FF 7F FF FF FF FF]
+     *   -1099511627775          -&gt; FF FF [FF 00 00 00 00 01]
+     *   -1099511627776          -&gt; FF FF [FF 00 00 00 00 00]
+     *   -1099511627777          -&gt; FF FF [FE FF FF FF FF FF]
+     *   -140737488355327        -&gt; FF FF [80 00 00 00 00 01]
+     *   -140737488355328        -&gt; FF FF [80 00 00 00 00 00]
+     *   -140737488355329        -&gt; FF [FF 7F FF FF FF FF FF]
+     *   -281474976710655        -&gt; FF [FF 00 00 00 00 00 01]
+     *   -281474976710656        -&gt; FF [FF 00 00 00 00 00 00]
+     *   -281474976710657        -&gt; FF [FE FF FF FF FF FF FF]
+     *   -36028797018963967      -&gt; FF [80 00 00 00 00 00 01]
+     *   -36028797018963968      -&gt; FF [80 00 00 00 00 00 00]
+     *   -36028797018963969      -&gt; [FF 7F FF FF FF FF FF FF]
+     *   -72057594037927936      -&gt; [FF 00 00 00 00 00 00 00]
+     *   -72057594037927937      -&gt; [FE FF FF FF FF FF FF FF]
+     *   -9223372036854775807    -&gt; [80 00 00 00 00 00 00 01]
+     *   -9223372036854775808    -&gt; [80 00 00 00 00 00 00 00]
      * </pre>
      * @param value The value to store in a byte array
      * @return The byte array representing the value.

Modified: directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/LongDecoder.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/LongDecoder.java?rev=1757873&r1=1757872&r2=1757873&view=diff
==============================================================================
--- directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/LongDecoder.java (original)
+++ directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/LongDecoder.java Fri Aug 26 15:07:54 2016
@@ -82,6 +82,10 @@ public final class LongDecoder
     /**
      * Helper method used to parse the long. We don't check any minimal or maximal
      * bound.
+     * 
+     * @param value The value to parse to a long
+     * @return The decoded long
+     * @throws LongDecoderException If we failed to decode a long
      */
     public static long parseLong( BerValue value ) throws LongDecoderException
     {

Modified: directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/UniversalTag.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/UniversalTag.java?rev=1757873&r1=1757872&r2=1757873&view=diff
==============================================================================
--- directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/UniversalTag.java (original)
+++ directory/shared/branches/shared-value/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/tlv/UniversalTag.java Fri Aug 26 15:07:54 2016
@@ -28,141 +28,139 @@ package org.apache.directory.api.asn1.be
  * <p>
  * These tags can have one of the following values:
  * </p>
- * <p>
- * </p>
- * <table border="1" cellspacing="1" width="60%">
- * <tr>
- * <th>Id</th>
- * <th>Usage</th>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 0]</td>
- * <td>reserved for BER</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 1]</td>
- * <td>BOOLEAN</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 2]</td>
- * <td>INTEGER</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 3]</td>
- * <td>BIT STRING</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 4]</td>
- * <td>OCTET STRING</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 5]</td>
- * <td>NULL</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 6]</td>
- * <td>OBJECT IDENTIFIER</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 7]</td>
- * <td>ObjectDescriptor</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 8]</td>
- * <td>EXTERNAL, INSTANCE OF</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 9]</td>
- * <td>REAL</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 10]</td>
- * <td>ENUMERATED</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 11]</td>
- * <td>EMBEDDED PDV</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 12]</td>
- * <td>UTF8String</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 13]</td>
- * <td>RELATIVE-OID</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 14]</td>
- * <td>reserved for future use</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 15]</td>
- * <td>reserved for future use</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 16]</td>
- * <td>SEQUENCE, SEQUENCE OF</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 17]</td>
- * <td>SET, SET OF</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 18]</td>
- * <td>NumericString</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 19]</td>
- * <td>PrintableString</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 20]</td>
- * <td>TeletexString, T61String</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 21]</td>
- * <td>VideotexString</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 22]</td>
- * <td>IA5String</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 23]</td>
- * <td>UTCTime</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 24]</td>
- * <td>GeneralizedTime</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 25]</td>
- * <td>GraphicString</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 26]</td>
- * <td>VisibleString, ISO646String</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 27]</td>
- * <td>GeneralString</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 28]</td>
- * <td>UniversalString</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 29]</td>
- * <td>CHARACTER STRING</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 30]</td>
- * <td>BMPString</td>
- * </tr>
- * <tr>
- * <td>[UNIVERSAL 31]</td>
- * <td>reserved for future use</td>
- * </tr>
+ * <table border="1" cellspacing="1" width="60%" summary="ASN.1 tags">
+ *   <tr>
+ *     <th>Id</th>
+ *     <th>Usage</th>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 0]</td>
+ *     <td>reserved for BER</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 1]</td>
+ *     <td>BOOLEAN</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 2]</td>
+ *     <td>INTEGER</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 3]</td>
+ *     <td>BIT STRING</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 4]</td>
+ *     <td>OCTET STRING</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 5]</td>
+ *     <td>NULL</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 6]</td>
+ *     <td>OBJECT IDENTIFIER</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 7]</td>
+ *     <td>ObjectDescriptor</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 8]</td>
+ *     <td>EXTERNAL, INSTANCE OF</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 9]</td>
+ *     <td>REAL</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 10]</td>
+ *     <td>ENUMERATED</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 11]</td>
+ *     <td>EMBEDDED PDV</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 12]</td>
+ *     <td>UTF8String</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 13]</td>
+ *     <td>RELATIVE-OID</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 14]</td>
+ *     <td>reserved for future use</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 15]</td>
+ *     <td>reserved for future use</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 16]</td>
+ *     <td>SEQUENCE, SEQUENCE OF</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 17]</td>
+ *     <td>SET, SET OF</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 18]</td>
+ *     <td>NumericString</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 19]</td>
+ *     <td>PrintableString</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 20]</td>
+ *     <td>TeletexString, T61String</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 21]</td>
+ *     <td>VideotexString</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 22]</td>
+ *     <td>IA5String</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 23]</td>
+ *     <td>UTCTime</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 24]</td>
+ *     <td>GeneralizedTime</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 25]</td>
+ *     <td>GraphicString</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 26]</td>
+ *     <td>VisibleString, ISO646String</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 27]</td>
+ *     <td>GeneralString</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 28]</td>
+ *     <td>UniversalString</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 29]</td>
+ *     <td>CHARACTER STRING</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 30]</td>
+ *     <td>BMPString</td>
+ *   </tr>
+ *   <tr>
+ *     <td>[UNIVERSAL 31]</td>
+ *     <td>reserved for future use</td>
+ *   </tr>
  * </table>
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>