You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by ak...@apache.org on 2004/01/13 08:03:26 UTC
svn commit: rev 6150 - incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema
Author: akarasulu
Date: Mon Jan 12 23:03:25 2004
New Revision: 6150
Modified:
incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/AttributeType.java
incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/BinarySyntaxChecker.java (contents, props changed)
incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/ContentRule.java
incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/DefaultSyntax.java (props changed)
incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/MatchingRule.java
incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/MatchingRuleUse.java
incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/NameForm.java
incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/ObjectClass.java
incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/RegexSyntaxChecker.java (props changed)
incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/StructureRule.java
incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/Syntax.java
Log:
Added some keyword expansion and made javadocs consistant.
Modified: incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/AttributeType.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/AttributeType.java (original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/AttributeType.java Mon Jan 12 23:03:25 2004
@@ -54,8 +54,9 @@
* An attributeType specification. attributeType specifications describe the
* nature of attributes within the directory. The attributeType specification's
* properties are accessible through this interface.
- *
+ * <p>
* According to ldapbis [MODELS]:
+ * </p>
* <pre>
* 4.1.2. Attribute Types
*
@@ -144,9 +145,8 @@
* although they may allow longer strings. Note that a single character
* of the Directory String syntax may be encoded in more than one octet
* since UTF-8 is a variable-length encoding.
- *
* </pre>
- *
+ *
* @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC 2252 Section 4.2</a>
* @see <a href=
* "http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-09.txt">
Modified: incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/BinarySyntaxChecker.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/BinarySyntaxChecker.java (original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/BinarySyntaxChecker.java Mon Jan 12 23:03:25 2004
@@ -54,7 +54,7 @@
/**
- * The Binary (a.k.a. universal-acceptor) syntax checker.
+ * A binary value (universal value acceptor) syntax checker.
*
* @author <a href="mailto:akarasulu@apache.org">Alex Karasulu</a>
* @author $Author$
Modified: incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/ContentRule.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/ContentRule.java (original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/ContentRule.java Mon Jan 12 23:03:25 2004
@@ -55,8 +55,9 @@
* entries of a particular structural objectClass. They specify the AUXILLARY
* objectClasses and additional attribute types permitted to appear, or excluded
* from appearing in entries of the indicated STRUCTURAL objectClass.
- *
+ * <p>
* According to ldapbis [MODELS]:
+ * </p>
* <pre>
* 4.1.6. DIT Content Rules
*
Modified: incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/MatchingRule.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/MatchingRule.java (original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/MatchingRule.java Mon Jan 12 23:03:25 2004
@@ -57,11 +57,13 @@
* A matchingRule definition. MatchingRules associate a comparator and a
* normalizer, forming the basic tools necessary to assert actions against
* attribute values. MatchingRules are associated with a specific Syntax
- * for the purpose of resolving a normalized form and for comparisons. Here's
- * what the ldapbis [MODELS] has to say about matchingRules:
- *
- * 4.1.3. Matching Rules
+ * for the purpose of resolving a normalized form and for comparisons.
+ * <p>
+ * According to ldapbis [MODELS]:
+ * </p>
* <pre>
+ * 4.1.3. Matching Rules
+ *
* Matching rules are used by servers to compare attribute values against
* assertion values when performing Search and Compare operations. They
* are also used to identify the value to be added or deleted when
Modified: incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/MatchingRuleUse.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/MatchingRuleUse.java (original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/MatchingRuleUse.java Mon Jan 12 23:03:25 2004
@@ -51,10 +51,10 @@
/**
- * Represents an LDAP MatchingRuleUseDescription defined in RFC 2252. The
- * MatchingRuleUseDescription syntax (1.3.6.1.4.1.1466.115.121.1.31) is defined
- * therein as follows:
- *
+ * Represents an LDAP MatchingRuleUseDescription defined in RFC 2252.
+ * <p>
+ * According to ldapbis [MODELS]:
+ * </p>
* <pre>
* Values of the matchingRuleUse list the attributes which are suitable
* for use with an extensible matching rule.
@@ -81,8 +81,6 @@
* to; and
* [extensions] describe extensions.
*
- * </pre>
- *
* The matchingRule within the MatchingRuleUse definition can be used by an
* extensible match assertion if the assertion is based on the attributes
* listed within the MatchingRuleUse definition. If an extensible match
@@ -96,6 +94,7 @@
* extensibleMatch search filter [PROT]. The LDAP-specific encoding of
* a value of this syntax is defined by the <MatchingRuleUseDescription>
* rule in [MODELS] above.
+ * </pre>
*
* @see <a href=
* "http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-09.txt">
Modified: incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/NameForm.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/NameForm.java (original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/NameForm.java Mon Jan 12 23:03:25 2004
@@ -54,9 +54,10 @@
* A nameForm description. NameForms define the relationship between a
* STRUCTURAL objectClass definition and the attributeTypes allowed to be used
* for the naming of an Entry of that objectClass: it defines which attributes
- * can be used for the RDN. The following refinement from ldapbis [MODELS]
- * clearly defines a nameForm as well as its syntax:
- *
+ * can be used for the RDN.
+ * <p>
+ * According to ldapbis [MODELS]:
+ * </p>
* <pre>
* 4.1.7.2. Name Forms
*
Modified: incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/ObjectClass.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/ObjectClass.java (original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/ObjectClass.java Mon Jan 12 23:03:25 2004
@@ -52,9 +52,12 @@
/**
* An objectClass definition.
- *
- * Object Class definitions are written according to the ABNF:
+ * <p>
+ * According to ldapbis [MODELS]:
+ * </p>
* <pre>
+ * Object Class definitions are written according to the ABNF:
+ *
* ObjectClassDescription = LPAREN WSP
* numericoid ; object identifier
* [ SP "NAME" SP qdescrs ] ; short names (descriptors)
@@ -80,8 +83,8 @@
* MUST and MAY specify the sets of required and allowed attribute
* types, respectively; and
* [extensions] describe extensions.
- *
* </pre>
+ *
* @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC2252 Section 4.4</a>
* @see <a href=
* "http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-09.txt">
Modified: incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/StructureRule.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/StructureRule.java (original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/StructureRule.java Mon Jan 12 23:03:25 2004
@@ -59,9 +59,12 @@
* as subordinates to entries governed by the indicated superior
* dITStructureRules. Hence dITStructureRules only apply to structural object
* classes.
- *
- * DIT structure rule descriptions are written according to the ABNF:
+ * <p>
+ * According to ldapbis [MODELS]:
+ * </p>
* <pre>
+ * DIT structure rule descriptions are written according to the ABNF:
+ *
* DITStructureRuleDescription = LPAREN WSP
* ruleid ; rule identifier
* [ SP "NAME" SP qdescrs ] ; short names (descriptors)
@@ -92,6 +95,7 @@
* to an autonomous administrative point (e.g. the root vertex of the
* subtree controlled by the subschema) [X.501].
* </pre>
+ *
* @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC2252 Section 6.33</a>
* @see <a href=
* "http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-09.txt">
Modified: incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/Syntax.java
==============================================================================
--- incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/Syntax.java (original)
+++ incubator/directory/ldap/trunk/eve/backend/schema/common/api/src/java/org/apache/eve/schema/Syntax.java Mon Jan 12 23:03:25 2004
@@ -57,9 +57,12 @@
* values conforming to the syntax are normally represented when transferred
* in LDAP operations. This representation is referred to as the LDAP-specific
* encoding to distinguish it from other methods of encoding attribute values.
- *
- * 4.1.5. LDAP Syntaxes
+ * <p>
+ * According to ldapbis [MODELS]:
+ * </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
@@ -80,8 +83,12 @@
* DESC [qdstring] is a short descriptive string; and
* [extensions] describe extensions.
* </pre>
- * @see <a href="http://www.faqs.org/rfcs/rfc2252.html">RFC2252 Section 4.3.3
- * </a>
+ *
+ * @see <a href="http://www.faqs.org/rfcs/rfc2252.html">
+ * RFC2252 Section 4.3.3</a>
+ * @see <a href=
+ * "http://www.ietf.org/internet-drafts/draft-ietf-ldapbis-models-09.txt">
+ * ldapbis [MODELS]</a>
* @see DescriptionUtils#getDescription(Syntax)
* @author <a href="mailto:akarasulu@apache.org">Alex Karasulu</a>
* @author $Author$