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/09/01 16:17:25 UTC
svn commit: r1758806 -
/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/
Author: elecharny
Date: Thu Sep 1 16:17:25 2016
New Revision: 1758806
URL: http://svn.apache.org/viewvc?rev=1758806&view=rev
Log:
Updated Javadocs
Modified:
directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AbstractExprNode.java
directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AndNode.java
directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/BranchNormalizedVisitor.java
directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterEncoder.java
directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterParser.java
directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterVisitor.java
directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/NotNode.java
directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/OrNode.java
directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/ScopeNode.java
directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AbstractExprNode.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AbstractExprNode.java?rev=1758806&r1=1758805&r2=1758806&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AbstractExprNode.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AbstractExprNode.java Thu Sep 1 16:17:25 2016
@@ -174,8 +174,7 @@ public abstract class AbstractExprNode i
/**
- * @see ExprNode#set(java.lang.Object,
- * java.lang.Object)
+ * @see ExprNode#set(String, Object)
*/
@Override
public void set( String key, Object value )
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AndNode.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AndNode.java?rev=1758806&r1=1758805&r2=1758806&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AndNode.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/AndNode.java Thu Sep 1 16:17:25 2016
@@ -107,7 +107,7 @@ 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
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/BranchNormalizedVisitor.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/BranchNormalizedVisitor.java?rev=1758806&r1=1758805&r2=1758806&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/BranchNormalizedVisitor.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/BranchNormalizedVisitor.java Thu Sep 1 16:17:25 2016
@@ -110,10 +110,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
{
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterEncoder.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterEncoder.java?rev=1758806&r1=1758805&r2=1758806&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterEncoder.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterEncoder.java Thu Sep 1 16:17:25 2016
@@ -46,7 +46,7 @@ public final class FilterEncoder
* Formats a filter and handles encoding of special characters in the value arguments using the
* <valueencoding> 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>(&(cn={0})(uid={1}))</code>
*
* @param filterTemplate the filter with placeholders
* @param values the values to encode and substitute
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterParser.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterParser.java?rev=1758806&r1=1758805&r2=1758806&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterParser.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterParser.java Thu Sep 1 16:17:25 2016
@@ -53,6 +53,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
{
@@ -68,6 +69,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
{
@@ -82,6 +84,7 @@ public final class FilterParser
* @param schemaManager The SchemaManager to use
* @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
{
@@ -97,6 +100,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( SchemaManager schemaManager, String filter, boolean relaxed ) throws ParseException
{
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterVisitor.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterVisitor.java?rev=1758806&r1=1758805&r2=1758806&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterVisitor.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/FilterVisitor.java Thu Sep 1 16:17:25 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/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/NotNode.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/NotNode.java?rev=1758806&r1=1758805&r2=1758806&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/NotNode.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/NotNode.java Thu Sep 1 16:17:25 2016
@@ -176,7 +176,7 @@ public class NotNode extends BranchNode
/**
- * @see ExprNode#printRefinementToBuffer(StringBuffer)
+ * @see ExprNode#printRefinementToBuffer(StringBuilder)
*
* @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/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/OrNode.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/OrNode.java?rev=1758806&r1=1758805&r2=1758806&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/OrNode.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/OrNode.java Thu Sep 1 16:17:25 2016
@@ -107,7 +107,7 @@ public class OrNode extends BranchNode
/**
- * @see ExprNode#printRefinementToBuffer(StringBuffer)
+ * @see ExprNode#printRefinementToBuffer(StringBuilder)
*
* @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/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/ScopeNode.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/ScopeNode.java?rev=1758806&r1=1758805&r2=1758806&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/ScopeNode.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/ScopeNode.java Thu Sep 1 16:17:25 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/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java?rev=1758806&r1=1758805&r2=1758806&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java Thu Sep 1 16:17:25 2016
@@ -43,10 +43,10 @@ public abstract class SimpleNode<T> exte
/** The value as a byte[] */
protected byte[] bytes;
- /** Constants for comparisons : > */
+ /** Constants for comparisons : @gt; */
public static final boolean EVAL_GREATER = true;
- /** Constants for comparisons : < */
+ /** Constants for comparisons : < */
public static final boolean EVAL_LESSER = false;