directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r1758807 - /directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/
Date Thu, 01 Sep 2016 16:17:43 GMT
Author: elecharny
Date: Thu Sep  1 16:17:43 2016
New Revision: 1758807

URL: http://svn.apache.org/viewvc?rev=1758807&view=rev
Log:
Updated Javadocs

Modified:
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AbstractExprNode.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AndNode.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/BranchNormalizedVisitor.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterEncoder.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterParser.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterVisitor.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/LeafNode.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/NotNode.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/OrNode.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/ScopeNode.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AbstractExprNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AbstractExprNode.java?rev=1758807&r1=1758806&r2=1758807&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AbstractExprNode.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AbstractExprNode.java
Thu Sep  1 16:17:43 2016
@@ -140,7 +140,7 @@ public abstract class AbstractExprNode i
      * Handles the escaping of special characters in LDAP search filter assertion values
using the
      * <valueencoding> rule as described in
      * <a href="http://www.ietf.org/rfc/rfc4515.txt">RFC 4515</a>. Needed so
that
-     * {@link ExprNode#printToBuffer(StringBuffer)} results in a valid filter string that
can be parsed
+     * {@link ExprNode#printRefinementToBuffer(StringBuilder)} results in a valid filter
string that can be parsed
      * again (as a way of cloning filters).
      *
      * @param value Right hand side of "attrId=value" assertion occurring in an LDAP search
filter.
@@ -261,8 +261,7 @@ public abstract class AbstractExprNode i
 
 
     /**
-     * @see ExprNode#set(java.lang.Object,
-     *      java.lang.Object)
+     * @see ExprNode#set(String, java.lang.Object)
      */
     public void set( String key, Object value )
     {

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AndNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AndNode.java?rev=1758807&r1=1758806&r2=1758807&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AndNode.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AndNode.java
Thu Sep  1 16:17:43 2016
@@ -107,11 +107,10 @@ public class AndNode extends BranchNode
 
 
     /**
-     * @see ExprNode#printRefinementToBuffer(StringBuffer)
+     * @see ExprNode#printRefinementToBuffer(StringBuilder)
      * 
      * @param buf the buffer to append to.
      * @return The buffer in which the refinement has been appended
-     * @throws UnsupportedOperationException if this node isn't a part of a refinement.
      */
     public StringBuilder printRefinementToBuffer( StringBuilder buf )
     {

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/BranchNormalizedVisitor.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/BranchNormalizedVisitor.java?rev=1758807&r1=1758806&r2=1758807&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/BranchNormalizedVisitor.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/BranchNormalizedVisitor.java
Thu Sep  1 16:17:43 2016
@@ -44,6 +44,9 @@ import org.apache.directory.api.ldap.mod
  */
 public class BranchNormalizedVisitor implements FilterVisitor
 {
+    /**
+     * {@inheritDoc}
+     */
     public Object visit( ExprNode node )
     {
         if ( !( node instanceof BranchNode ) )
@@ -84,18 +87,27 @@ public class BranchNormalizedVisitor imp
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public boolean canVisit( ExprNode node )
     {
         return node instanceof BranchNode;
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public boolean isPrefix()
     {
         return false;
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public List<ExprNode> getOrder( BranchNode node, List<ExprNode> children
)
     {
         return children;
@@ -106,10 +118,10 @@ public class BranchNormalizedVisitor imp
      * Normalizes a filter expression to a canonical representation while
      * retaining logical meaning of the expression.
      * 
+     * @param schemaManager The SchemaManager
      * @param filter the filter to normalize
      * @return the normalized version of the filter
-     * @throws java.text.ParseException
-     *             if the filter is malformed
+     * @throws java.text.ParseException if the filter is malformed
      */
     public static String getNormalizedFilter( SchemaManager schemaManager, String filter
) throws ParseException
     {
@@ -123,8 +135,7 @@ public class BranchNormalizedVisitor imp
      * Normalizes a filter expression to a canonical representation while
      * retaining logical meaning of the expression.
      * 
-     * @param filter
-     *            the filter to normalize
+     * @param filter the filter to normalize
      * @return the normalized String version of the filter
      */
     public static String getNormalizedFilter( ExprNode filter )

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterEncoder.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterEncoder.java?rev=1758807&r1=1758806&r2=1758807&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterEncoder.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterEncoder.java
Thu Sep  1 16:17:43 2016
@@ -46,7 +46,7 @@ public final class FilterEncoder
      * Formats a filter and handles encoding of special characters in the value arguments
using the
      * &lt;valueencoding&gt; rule as described in <a href="http://www.ietf.org/rfc/rfc4515.txt">RFC
4515</a>.
      * <p>
-     * Example of filter template format: <code>(&(cn={0})(uid={1}))</code>
+     * Example of filter template format: <code>(&amp;,(cn={0})(uid={1}))</code>
      * 
      * @param filterTemplate the filter with placeholders
      * @param values the values to encode and substitute

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterParser.java?rev=1758807&r1=1758806&r2=1758807&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterParser.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterParser.java
Thu Sep  1 16:17:43 2016
@@ -964,6 +964,7 @@ public final class FilterParser
      * 
      * @param filter the search filter in it's string representation
      * @return the expression node object
+     * @throws ParseException If the filter is invalid
      */
     public static ExprNode parse( String filter ) throws ParseException
     {
@@ -973,6 +974,10 @@ public final class FilterParser
 
     /**
      * @see FilterParser#parse(String)
+     * 
+     * @param filter the search filter in it's string representation
+     * @return the expression node object
+     * @throws ParseException If the filter is invalid
      */
     public static ExprNode parse( byte[] filter ) throws ParseException
     {
@@ -982,6 +987,11 @@ public final class FilterParser
 
     /**
      * @see FilterParser#parse(String)
+     * 
+     * @param schemaManager The SchemaManager
+     * @param filter the search filter in it's string representation
+     * @return the expression node object
+     * @throws ParseException If the filter is invalid
      */
     public static ExprNode parse( SchemaManager schemaManager, String filter ) throws ParseException
     {
@@ -991,6 +1001,11 @@ public final class FilterParser
 
     /**
      * @see FilterParser#parse(String)
+     * 
+     * @param schemaManager The SchemaManager
+     * @param filter the search filter in it's string representation
+     * @return the expression node object
+     * @throws ParseException If the filter is invalid
      */
     public static ExprNode parse( SchemaManager schemaManager, byte[] filter ) throws ParseException
     {
@@ -1025,6 +1040,12 @@ public final class FilterParser
 
     /**
      * @see FilterParser#parse(String)
+     * 
+     * @param schemaManager The SchemaManager
+     * @param filter the search filter in it's string representation
+     * @param pos The position in the filter
+     * @return the expression node object
+     * @throws ParseException If the filter is invalid
      */
     public static ExprNode parse( SchemaManager schemaManager, String filter, Position pos
) throws ParseException
     {
@@ -1057,6 +1078,7 @@ public final class FilterParser
      * @param filter the search filter in it's string representation
      * @param relaxed <code>true</code> to parse the filter in relaxed mode
      * @return the expression node object
+     * @throws ParseException If the filter is invalid
      */
     public static ExprNode parse( String filter, boolean relaxed ) throws ParseException
     {

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterVisitor.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterVisitor.java?rev=1758807&r1=1758806&r2=1758807&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterVisitor.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterVisitor.java
Thu Sep  1 16:17:43 2016
@@ -28,16 +28,18 @@ import java.util.List;
  * of the extrinsic visitor variation. It has the following advantages over the
  * standard visitor pattern:
  * <ul>
- * <li>Visitor takes responsibility that a visitor can visit a node</li>
- * <li>Each visitor knows which types of concrete classes it can visit</li>
- * <li>New visitors can be created without changing the node class</li>
- * <li>New node classes can be added without having to change old visitors</li>
- * <li>Visitation order can be controled in every respect:</li>
- * <ul>
- * <li>Visitation rejection with canVisit() and/or getOrder()</li>
- * <li>Recursive visitation ordering with isPrefix()</li>
- * <li>Child visitation ordering with getOrder()</li>
- * </ul>
+ *   <li>Visitor takes responsibility that a visitor can visit a node</li>
+ *   <li>Each visitor knows which types of concrete classes it can visit</li>
+ *   <li>New visitors can be created without changing the node class</li>
+ *   <li>New node classes can be added without having to change old visitors</li>
+ *   <li>Visitation order can be controled in every respect:</li>
+ *   <li>
+ *     <ul>
+ *       <li>Visitation rejection with canVisit() and/or getOrder()</li>
+ *       <li>Recursive visitation ordering with isPrefix()</li>
+ *       <li>Child visitation ordering with getOrder()</li>
+ *     </ul>
+ *   </li>
  * </ul>
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/LeafNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/LeafNode.java?rev=1758807&r1=1758806&r2=1758807&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/LeafNode.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/LeafNode.java
Thu Sep  1 16:17:43 2016
@@ -63,7 +63,7 @@ public abstract class LeafNode extends A
     /**
      * Creates a leaf node.
      * 
-     * @param attributeType the attribute this node is based on
+     * @param attribute the attribute this node is based on
      * @param assertionType the type of this leaf node
      */
     protected LeafNode( String attribute, AssertionType assertionType )

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/NotNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/NotNode.java?rev=1758807&r1=1758806&r2=1758807&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/NotNode.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/NotNode.java
Thu Sep  1 16:17:43 2016
@@ -169,8 +169,9 @@ public class NotNode extends BranchNode
 
 
     /**
-     * @see ExprNode#printRefinementToBuffer(StringBuffer)
+     * @see ExprNode#printRefinementToBuffer(StringBuilder)
      * 
+     * @param buf The buffer where we store the result
      * @return The buffer in which the refinement has been appended
      * @throws UnsupportedOperationException if this node isn't a part of a refinement.
      */

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/OrNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/OrNode.java?rev=1758807&r1=1758806&r2=1758807&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/OrNode.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/OrNode.java
Thu Sep  1 16:17:43 2016
@@ -107,8 +107,9 @@ public class OrNode extends BranchNode
 
 
     /**
-     * @see ExprNode#printRefinementToBuffer(StringBuffer)
+     * @see ExprNode#printRefinementToBuffer(StringBuilder)
      * 
+     * @param buf The buffer that will contain the result
      * @return The buffer in which the refinement has been appended
      * @throws UnsupportedOperationException if this node isn't a part of a refinement.
      */

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/ScopeNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/ScopeNode.java?rev=1758807&r1=1758806&r2=1758807&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/ScopeNode.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/ScopeNode.java
Thu Sep  1 16:17:43 2016
@@ -51,6 +51,7 @@ public class ScopeNode extends AbstractE
      * 
      * @param aliasDerefAliases the alias dereferencing mode
      * @param baseDn the search base
+     * @param baseId the search ID
      * @param scope the search scope
      */
     public ScopeNode( AliasDerefMode aliasDerefAliases, Dn baseDn, String baseId, SearchScope
scope )

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java?rev=1758807&r1=1758806&r2=1758807&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java
(original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java
Thu Sep  1 16:17:43 2016
@@ -36,10 +36,10 @@ public abstract class SimpleNode<T> exte
     /** the value */
     protected Value<T> value;
 
-    /** Constants for comparisons : > */
+    /** Constants for comparisons : &gt; */
     public static final boolean EVAL_GREATER = true;
 
-    /** Constants for comparisons : < */
+    /** Constants for comparisons : &lt; */
     public static final boolean EVAL_LESSER = false;
 
 
@@ -60,7 +60,7 @@ public abstract class SimpleNode<T> exte
     /**
      * Creates a new SimpleNode object.
      * 
-     * @param attribute the attribute name
+     * @param attributeType the attribute name
      * @param value the value to test for
      * @param assertionType the type of assertion represented by this ExprNode
      */



Mime
View raw message