directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ersi...@apache.org
Subject svn commit: r431248 - in /directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions: MatchingRule.java Syntax.java
Date Sun, 13 Aug 2006 21:45:38 GMT
Author: ersiner
Date: Sun Aug 13 14:45:37 2006
New Revision: 431248

URL: http://svn.apache.org/viewvc?rev=431248&view=rev
Log:
Added more javadoc.

Modified:
    directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/MatchingRule.java
    directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/Syntax.java

Modified: directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/MatchingRule.java
URL: http://svn.apache.org/viewvc/directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/MatchingRule.java?rev=431248&r1=431247&r2=431248&view=diff
==============================================================================
--- directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/MatchingRule.java
(original)
+++ directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/MatchingRule.java
Sun Aug 13 14:45:37 2006
@@ -27,40 +27,41 @@
  * attribute values. MatchingRules are associated with a specific Syntax for the
  * purpose of resolving a normalized form and for comparisons.
  * <p>
- * According to rfc 4512:
+ * According to RFC 4512:
  * </p>
  * 
  * <pre>
- *  4.1.3.  Matching Rules
+ * 4.1.3.  Matching Rules
  *
- *     Matching rules are used in performance of attribute value assertions,
- *     such as in performance of a Compare operation.  They are also used in
- *     evaluating search filters, determining which individual values are to
- *     be added or deleted during performance of a Modify operation, and in
- *     comparing distinguished names.
+ *    Matching rules are used in performance of attribute value assertions,
+ *    such as in performance of a Compare operation.  They are also used in
+ *    evaluating search filters, determining which individual values are to
+ *    be added or deleted during performance of a Modify operation, and in
+ *    comparing distinguished names.
  *
- *     Each matching rule is identified by an object identifier (OID) and,
- *     optionally, one or more short names (descriptors).
+ *    Each matching rule is identified by an object identifier (OID) and,
+ *    optionally, one or more short names (descriptors).
  * 
- *     Matching rule definitions are written according to the ABNF:
+ *    Matching rule definitions are written according to the ABNF:
  * 
- *       MatchingRuleDescription = LPAREN WSP
- *           numericoid                 ; object identifier
- *           [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
- *           [ SP "DESC" SP qdstring ]  ; description
- *           [ SP "OBSOLETE" ]          ; not active
- *             SP "SYNTAX" SP numericoid  ; assertion syntax
- *             extensions WSP RPAREN      ; extensions
+ *      MatchingRuleDescription = LPAREN WSP
+ *          numericoid                 ; object identifier
+ *          [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
+ *          [ SP "DESC" SP qdstring ]  ; description
+ *          [ SP "OBSOLETE" ]          ; not active
+ *            SP "SYNTAX" SP numericoid  ; assertion syntax
+ *            extensions WSP RPAREN      ; extensions
  *
- *     where:
- *       <numericoid> is object identifier assigned to this matching rule;
- *       NAME <qdescrs> are short names (descriptors) identifying this
- *          matching rule;
- *       DESC <qdstring> is a short descriptive string;
- *       OBSOLETE indicates this matching rule is not active;
- *       SYNTAX identifies the assertion syntax (the syntax of the assertion
- *          value) by object identifier; and
- *       <extensions> describe extensions. * </pre>
+ *    where:
+ *      <numericoid> is object identifier assigned to this matching rule;
+ *      NAME <qdescrs> are short names (descriptors) identifying this
+ *         matching rule;
+ *      DESC <qdstring> is a short descriptive string;
+ *      OBSOLETE indicates this matching rule is not active;
+ *      SYNTAX identifies the assertion syntax (the syntax of the assertion
+ *         value) by object identifier; and
+ *      <extensions> describe extensions. *
+ * </pre>
  * 
  * @see <a href="http://www.faqs.org/rfcs/rfc4512.html">RFC 4512 Section 4.1.3</a>
  * @see DescriptionUtils#getDescription(MatchingRule)

Modified: directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/Syntax.java
URL: http://svn.apache.org/viewvc/directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/Syntax.java?rev=431248&r1=431247&r2=431248&view=diff
==============================================================================
--- directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/Syntax.java
(original)
+++ directory/sandbox/akarasulu/apacheds-2.0/schema/descriptions/src/main/java/org/apache/directory/server2/schema/descriptions/Syntax.java
Sun Aug 13 14:45:37 2006
@@ -23,8 +23,36 @@
 /**
  * A syntax definition. Each attribute stored in a directory has a defined
  * syntax (i.e. data type) which constrains the structure and format of its
- * values.  
+ * values.
+ * <p>
+ * According to RFC 4512:
+ * </p>
  * 
+ * <pre>
+ * 4.1.5.  LDAP Syntaxes
+
+ *    LDAP Syntaxes of (attribute and assertion) values are described in
+ *    terms of ASN.1 [X.680] and, optionally, have an octet string encoding
+ *    known as the LDAP-specific encoding.  Commonly, the LDAP-specific
+ *    encoding is constrained to a string of Unicode [Unicode] characters
+ *    in UTF-8 [RFC3629] form.
+ *
+ *    Each LDAP syntax is identified by an object identifier (OID).
+ *
+ *    LDAP syntax definitions are written according to the ABNF:
+ *
+ *      SyntaxDescription = LPAREN WSP
+ *          numericoid                 ; object identifier
+ *          [ SP "DESC" SP qdstring ]  ; description
+ *          extensions WSP RPAREN      ; extensions
+ *
+ *    where:
+ *      <numericoid> is the object identifier assigned to this LDAP syntax;
+ *      DESC <qdstring> is a short descriptive string; and
+ *      <extensions> describe extensions.
+ * </pre>
+ * 
+ * @see <a href="http://www.faqs.org/rfcs/rfc4512.html">RFC 4512 Section 4.1.5</a>
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  * @version $Rev$
  */



Mime
View raw message