Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id EB87F200B74 for ; Thu, 1 Sep 2016 18:17:50 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id E9EBA160AB5; Thu, 1 Sep 2016 16:17:50 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id BEEA6160AA8 for ; Thu, 1 Sep 2016 18:17:49 +0200 (CEST) Received: (qmail 94976 invoked by uid 500); 1 Sep 2016 16:17:49 -0000 Mailing-List: contact commits-help@directory.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@directory.apache.org Delivered-To: mailing list commits@directory.apache.org Received: (qmail 94966 invoked by uid 99); 1 Sep 2016 16:17:49 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd2-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 01 Sep 2016 16:17:48 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd2-us-west.apache.org (ASF Mail Server at spamd2-us-west.apache.org) with ESMTP id 9037F1A0050 for ; Thu, 1 Sep 2016 16:17:48 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd2-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 0.374 X-Spam-Level: X-Spam-Status: No, score=0.374 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, RP_MATCHES_RCVD=-1.426] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd2-us-west.apache.org [10.40.0.9]) (amavisd-new, port 10024) with ESMTP id RYPWWasvHCSr for ; Thu, 1 Sep 2016 16:17:45 +0000 (UTC) Received: from mailrelay1-us-west.apache.org (mailrelay1-us-west.apache.org [209.188.14.139]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with ESMTP id B2C395FD02 for ; Thu, 1 Sep 2016 16:17:44 +0000 (UTC) Received: from svn01-us-west.apache.org (svn.apache.org [10.41.0.6]) by mailrelay1-us-west.apache.org (ASF Mail Server at mailrelay1-us-west.apache.org) with ESMTP id 30717E047B for ; Thu, 1 Sep 2016 16:17:44 +0000 (UTC) Received: from svn01-us-west.apache.org (localhost [127.0.0.1]) by svn01-us-west.apache.org (ASF Mail Server at svn01-us-west.apache.org) with ESMTP id 1000A3A02BD for ; Thu, 1 Sep 2016 16:17:44 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit 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 -0000 To: commits@directory.apache.org From: elecharny@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20160901161744.1000A3A02BD@svn01-us-west.apache.org> archived-at: Thu, 01 Sep 2016 16:17:51 -0000 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 * RFC 4515. 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 getOrder( BranchNode node, List 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 * <valueencoding> rule as described in RFC 4515. *

- * Example of filter template format: (&(cn={0})(uid={1})) + * Example of filter template format: (&,(cn={0})(uid={1})) * * @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 true 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: *

    - *
  • Visitor takes responsibility that a visitor can visit a node
    • - *
  • Each visitor knows which types of concrete classes it can visit
    • - *
  • New visitors can be created without changing the node class
    • - *
  • New node classes can be added without having to change old visitors
    • - *
  • Visitation order can be controled in every respect:
    • - *
      - *
    • Visitation rejection with canVisit() and/or getOrder()
      • - *
    • Recursive visitation ordering with isPrefix()
      • - *
    • Child visitation ordering with getOrder()
      • - *
    + *
  • Visitor takes responsibility that a visitor can visit a node
    • + *
  • Each visitor knows which types of concrete classes it can visit
    • + *
  • New visitors can be created without changing the node class
    • + *
  • New node classes can be added without having to change old visitors
    • + *
  • Visitation order can be controled in every respect:
    • + *
  • + *
      + *
    • Visitation rejection with canVisit() and/or getOrder()
      • + *
    • Recursive visitation ordering with isPrefix()
      • + *
    • Child visitation ordering with getOrder()
      • + *
    + *
    • *
* * @author Apache Directory Project 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 exte /** the value */ protected Value value; - /** Constants for comparisons : > */ + /** Constants for comparisons : > */ public static final boolean EVAL_GREATER = true; - /** Constants for comparisons : < */ + /** Constants for comparisons : < */ public static final boolean EVAL_LESSER = false; @@ -60,7 +60,7 @@ public abstract class SimpleNode 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 */