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/12/01 17:52:25 UTC

svn commit: r1772242 - in /directory/shared/trunk: asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/ asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/ i18n/src/main/java/org/apache/directory/api/i18n/

Author: elecharny
Date: Thu Dec  1 17:52:24 2016
New Revision: 1772242

URL: http://svn.apache.org/viewvc?rev=1772242&view=rev
Log:
Added some missing Javadoc

Modified:
    directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadBitString.java
    directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadInteger.java
    directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadOctetString.java
    directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/CheckNotNullLength.java
    directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/AbstractGrammar.java
    directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/Action.java
    directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/Grammar.java
    directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/GrammarAction.java
    directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/GrammarTransition.java
    directory/shared/trunk/i18n/src/main/java/org/apache/directory/api/i18n/I18n.java

Modified: directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadBitString.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadBitString.java?rev=1772242&r1=1772241&r2=1772242&view=diff
==============================================================================
--- directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadBitString.java (original)
+++ directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadBitString.java Thu Dec  1 17:52:24 2016
@@ -33,7 +33,7 @@ import org.slf4j.LoggerFactory;
 /**
  * The action used read a BITSTRING from a TLV
  * 
- * @param C The container type
+ * @param <C> The container type
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadInteger.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadInteger.java?rev=1772242&r1=1772241&r2=1772242&view=diff
==============================================================================
--- directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadInteger.java (original)
+++ directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadInteger.java Thu Dec  1 17:52:24 2016
@@ -36,7 +36,7 @@ import org.slf4j.LoggerFactory;
 /**
  * The action used to read an integer value
  *
- * @param E The container type
+ * @param <E> The container type
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadOctetString.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadOctetString.java?rev=1772242&r1=1772241&r2=1772242&view=diff
==============================================================================
--- directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadOctetString.java (original)
+++ directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/AbstractReadOctetString.java Thu Dec  1 17:52:24 2016
@@ -33,7 +33,7 @@ import org.slf4j.LoggerFactory;
 /**
  * The action used to read an OCTET STRING value
  *
- * @param C The container type
+ * @param <C> The container type
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/CheckNotNullLength.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/CheckNotNullLength.java?rev=1772242&r1=1772241&r2=1772242&view=diff
==============================================================================
--- directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/CheckNotNullLength.java (original)
+++ directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/CheckNotNullLength.java Thu Dec  1 17:52:24 2016
@@ -32,7 +32,7 @@ import org.slf4j.LoggerFactory;
 /**
  * An action that checks the length is not null
  *
- * @param C The container type
+ * @param <C> The container type
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/AbstractGrammar.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/AbstractGrammar.java?rev=1772242&r1=1772241&r2=1772242&view=diff
==============================================================================
--- directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/AbstractGrammar.java (original)
+++ directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/AbstractGrammar.java Thu Dec  1 17:52:24 2016
@@ -32,7 +32,7 @@ import org.slf4j.LoggerFactory;
  * The abstract Grammar which is the Mother of all the grammars. It contains
  * the transitions table.
  *
- * @param C The container type
+ * @param <C> The container type
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/Action.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/Action.java?rev=1772242&r1=1772241&r2=1772242&view=diff
==============================================================================
--- directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/Action.java (original)
+++ directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/Action.java Thu Dec  1 17:52:24 2016
@@ -28,7 +28,7 @@ import org.apache.directory.api.asn1.ber
  * Action interface just contains the method 'action' which must be implemented
  * in all the implementing classes.
  * 
- * @param C The container type
+ * @param <C> The container type
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/Grammar.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/Grammar.java?rev=1772242&r1=1772241&r2=1772242&view=diff
==============================================================================
--- directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/Grammar.java (original)
+++ directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/Grammar.java Thu Dec  1 17:52:24 2016
@@ -27,7 +27,7 @@ import org.apache.directory.api.asn1.ber
 /**
  * The interface which expose common behavior of a Grammar implementer.
  *
- * @param C The container type
+ * @param <C> The container type
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/GrammarAction.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/GrammarAction.java?rev=1772242&r1=1772241&r2=1772242&view=diff
==============================================================================
--- directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/GrammarAction.java (original)
+++ directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/GrammarAction.java Thu Dec  1 17:52:24 2016
@@ -27,7 +27,7 @@ import org.apache.directory.api.asn1.ber
  * A top level grammar class that store meta informations about the actions.
  * Those informations are not mandatory, but they can be useful for debugging.
  * 
- * @param C The container type
+ * @param <C> The container type
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/GrammarTransition.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/GrammarTransition.java?rev=1772242&r1=1772241&r2=1772242&view=diff
==============================================================================
--- directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/GrammarTransition.java (original)
+++ directory/shared/trunk/asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/grammar/GrammarTransition.java Thu Dec  1 17:52:24 2016
@@ -29,7 +29,7 @@ import org.apache.directory.api.asn1.uti
  * Define a transition between two states of a grammar. It stores the next
  * state, and the action to execute while executing the transition.
  * 
- * @param C The container type
+ * @param <C> The container type
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/trunk/i18n/src/main/java/org/apache/directory/api/i18n/I18n.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/i18n/src/main/java/org/apache/directory/api/i18n/I18n.java?rev=1772242&r1=1772241&r2=1772242&view=diff
==============================================================================
--- directory/shared/trunk/i18n/src/main/java/org/apache/directory/api/i18n/I18n.java (original)
+++ directory/shared/trunk/i18n/src/main/java/org/apache/directory/api/i18n/I18n.java Thu Dec  1 17:52:24 2016
@@ -890,7 +890,13 @@ public enum I18n
         }
     }
 
-
+    /**
+     * Format a message injecting some parameters in the pattern.
+     * 
+     * @param pattern The message pattern
+     * @param args The arguments to inject in the pattern
+     * @return The resulting messages
+     */
     public static String format( String pattern, Object... args )
     {
         return new MessageFormat( pattern, Locale.ROOT ).format( args );