You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by se...@apache.org on 2010/10/04 20:44:51 UTC
svn commit: r1004355 -
/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/
Author: seelmann
Date: Mon Oct 4 18:44:51 2010
New Revision: 1004355
URL: http://svn.apache.org/viewvc?rev=1004355&view=rev
Log:
Fixed Javadoc and formatting
Modified:
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/AttributeTypeDescriptionSchemaParser.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/DITContentRuleDescriptionSchemaParser.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/DITStructureRuleDescriptionSchemaParser.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/LdapComparatorDescription.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/LdapComparatorDescriptionSchemaParser.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/LdapSyntaxDescriptionSchemaParser.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/MatchingRuleDescriptionSchemaParser.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/MatchingRuleUseDescriptionSchemaParser.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/NameFormDescriptionSchemaParser.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/NormalizerDescription.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/NormalizerDescriptionSchemaParser.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/ObjectClassDescriptionSchemaParser.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/ReusableAntlrSchemaParser.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/SyntaxCheckerDescription.java
directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/SyntaxCheckerDescriptionSchemaParser.java
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/AttributeTypeDescriptionSchemaParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/AttributeTypeDescriptionSchemaParser.java?rev=1004355&r1=1004354&r2=1004355&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/AttributeTypeDescriptionSchemaParser.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/AttributeTypeDescriptionSchemaParser.java Mon Oct 4 18:44:51 2010
@@ -129,10 +129,11 @@ public class AttributeTypeDescriptionSch
/**
- * Parses a AttributeType description
+ * Parses a AttributeType description.
*
* @param schemaDescription The AttributeType description to parse
* @return An instance of AttributeType
+ * @throws ParseException {@inheritDoc}
*/
public AttributeType parse( String schemaDescription ) throws ParseException
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/DITContentRuleDescriptionSchemaParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/DITContentRuleDescriptionSchemaParser.java?rev=1004355&r1=1004354&r2=1004355&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/DITContentRuleDescriptionSchemaParser.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/DITContentRuleDescriptionSchemaParser.java Mon Oct 4 18:44:51 2010
@@ -41,6 +41,7 @@ public class DITContentRuleDescriptionSc
/** The LoggerFactory used by this class */
protected static final Logger LOG = LoggerFactory.getLogger( DITContentRuleDescriptionSchemaParser.class );
+
/**
* Creates a schema parser instance.
*/
@@ -85,7 +86,7 @@ public class DITContentRuleDescriptionSc
try
{
DITContentRule ditContentRule = parser.ditContentRuleDescription();
-
+
// Update the schemaName
updateSchemaName( ditContentRule );
@@ -108,10 +109,11 @@ public class DITContentRuleDescriptionSc
/**
- * Parses a DITContentRule description
+ * Parses a DITContentRule description.
*
* @param schemaDescription The DITContentRule description to parse
* @return An instance of DITContentRule
+ * @throws ParseException {@inheritDoc}
*/
public DITContentRule parse( String schemaDescription ) throws ParseException
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/DITStructureRuleDescriptionSchemaParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/DITStructureRuleDescriptionSchemaParser.java?rev=1004355&r1=1004354&r2=1004355&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/DITStructureRuleDescriptionSchemaParser.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/DITStructureRuleDescriptionSchemaParser.java Mon Oct 4 18:44:51 2010
@@ -112,10 +112,11 @@ public class DITStructureRuleDescription
/**
- * Parses a DITStructureRule description
+ * Parses a DITStructureRule description.
*
* @param schemaDescription The DITStructureRule description to parse
* @return An instance of DITStructureRule
+ * @throws ParseException {@inheritDoc}
*/
public DITStructureRule parse( String schemaDescription ) throws ParseException
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/LdapComparatorDescription.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/LdapComparatorDescription.java?rev=1004355&r1=1004354&r2=1004355&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/LdapComparatorDescription.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/LdapComparatorDescription.java Mon Oct 4 18:44:51 2010
@@ -20,6 +20,7 @@
package org.apache.directory.shared.ldap.schema.parsers;
+
import org.apache.directory.shared.ldap.schema.LoadableSchemaObject;
import org.apache.directory.shared.ldap.schema.SchemaObjectType;
@@ -34,8 +35,9 @@ public class LdapComparatorDescription e
/** The serialVersionUID */
private static final long serialVersionUID = 1L;
+
/**
- * A constructor for a LdapComparatorDescription
+ * A constructor for a LdapComparatorDescription.
* @param oid The associated OID
*/
public LdapComparatorDescription( String oid )
@@ -43,9 +45,9 @@ public class LdapComparatorDescription e
super( SchemaObjectType.COMPARATOR, oid );
}
-
+
/**
- * @see Object#toString()
+ * {@inheritDoc}
*/
public String toString()
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/LdapComparatorDescriptionSchemaParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/LdapComparatorDescriptionSchemaParser.java?rev=1004355&r1=1004354&r2=1004355&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/LdapComparatorDescriptionSchemaParser.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/LdapComparatorDescriptionSchemaParser.java Mon Oct 4 18:44:51 2010
@@ -40,6 +40,7 @@ public class LdapComparatorDescriptionSc
/** The LoggerFactory used by this class */
protected static final Logger LOG = LoggerFactory.getLogger( LdapComparatorDescriptionSchemaParser.class );
+
/**
* Creates a schema parser instance.
*/
@@ -77,7 +78,7 @@ public class LdapComparatorDescriptionSc
throws ParseException
{
LOG.debug( "Parsing a Comparator : {}", comparatorDescription );
-
+
if ( comparatorDescription == null )
{
LOG.error( I18n.err( I18n.ERR_04236 ) );
@@ -87,12 +88,11 @@ public class LdapComparatorDescriptionSc
synchronized ( parser )
{
reset( comparatorDescription ); // reset and initialize the parser / lexer pair
-
+
try
{
LdapComparatorDescription ldapComparatorDescription = parser.ldapComparator();
LOG.debug( "Parsed a LdapComparator : {}", ldapComparatorDescription );
-
// Update the schemaName
updateSchemaName( ldapComparatorDescription );
@@ -116,10 +116,11 @@ public class LdapComparatorDescriptionSc
/**
- * Parses a LdapComparator description
+ * Parses a LdapComparator description.
*
* @param schemaDescription The LdapComparator description to parse
* @return An instance of LdapComparatorDescription
+ * @throws ParseException {@inheritDoc}
*/
public LdapComparatorDescription parse( String schemaDescription ) throws ParseException
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/LdapSyntaxDescriptionSchemaParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/LdapSyntaxDescriptionSchemaParser.java?rev=1004355&r1=1004354&r2=1004355&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/LdapSyntaxDescriptionSchemaParser.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/LdapSyntaxDescriptionSchemaParser.java Mon Oct 4 18:44:51 2010
@@ -41,6 +41,7 @@ public class LdapSyntaxDescriptionSchema
/** The LoggerFactory used by this class */
protected static final Logger LOG = LoggerFactory.getLogger( LdapSyntaxDescriptionSchemaParser.class );
+
/**
* Creates a schema parser instance.
*/
@@ -83,7 +84,7 @@ public class LdapSyntaxDescriptionSchema
// Update the schemaName
updateSchemaName( ldapSyntax );
-
+
return ldapSyntax;
}
catch ( RecognitionException re )
@@ -95,17 +96,18 @@ public class LdapSyntaxDescriptionSchema
catch ( TokenStreamException tse )
{
String msg = I18n.err( I18n.ERR_04241, ldapSyntaxDescription, tse.getMessage() );
- LOG.error( msg );
+ LOG.error( msg );
throw new ParseException( msg, 0 );
}
}
/**
- * Parses a LdapSyntax description
+ * Parses a LdapSyntax description.
*
* @param schemaDescription The LdapSyntax description to parse
* @return An instance of LdapSyntax
+ * @throws ParseException {@inheritDoc}
*/
public LdapSyntax parse( String schemaDescription ) throws ParseException
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/MatchingRuleDescriptionSchemaParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/MatchingRuleDescriptionSchemaParser.java?rev=1004355&r1=1004354&r2=1004355&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/MatchingRuleDescriptionSchemaParser.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/MatchingRuleDescriptionSchemaParser.java Mon Oct 4 18:44:51 2010
@@ -41,6 +41,7 @@ public class MatchingRuleDescriptionSche
/** The LoggerFactory used by this class */
protected static final Logger LOG = LoggerFactory.getLogger( MatchingRuleDescriptionSchemaParser.class );
+
/**
* Creates a schema parser instance.
*/
@@ -85,7 +86,7 @@ public class MatchingRuleDescriptionSche
try
{
MatchingRule matchingRule = parser.matchingRuleDescription();
-
+
// Update the schemaName
updateSchemaName( matchingRule );
@@ -107,10 +108,11 @@ public class MatchingRuleDescriptionSche
/**
- * Parses a MatchingRule description
+ * Parses a MatchingRule description.
*
* @param schemaDescription The MatchingRule description to parse
* @return An instance of MatchingRule
+ * @throws ParseException {@inheritDoc}
*/
public MatchingRule parse( String schemaDescription ) throws ParseException
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/MatchingRuleUseDescriptionSchemaParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/MatchingRuleUseDescriptionSchemaParser.java?rev=1004355&r1=1004354&r2=1004355&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/MatchingRuleUseDescriptionSchemaParser.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/MatchingRuleUseDescriptionSchemaParser.java Mon Oct 4 18:44:51 2010
@@ -86,7 +86,7 @@ public class MatchingRuleUseDescriptionS
try
{
MatchingRuleUse matchingRuleUse = parser.matchingRuleUseDescription();
-
+
// Update the schemaName
updateSchemaName( matchingRuleUse );
@@ -109,10 +109,11 @@ public class MatchingRuleUseDescriptionS
/**
- * Parses a MatchingRuleUse description
+ * Parses a MatchingRuleUse description.
*
* @param schemaDescription The MatchingRuleUse description to parse
* @return An instance of MatchingRuleUse
+ * @throws ParseException {@inheritDoc}
*/
public MatchingRuleUse parse( String schemaDescription ) throws ParseException
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/NameFormDescriptionSchemaParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/NameFormDescriptionSchemaParser.java?rev=1004355&r1=1004354&r2=1004355&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/NameFormDescriptionSchemaParser.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/NameFormDescriptionSchemaParser.java Mon Oct 4 18:44:51 2010
@@ -41,6 +41,7 @@ public class NameFormDescriptionSchemaPa
/** The LoggerFactory used by this class */
protected static final Logger LOG = LoggerFactory.getLogger( NameFormDescriptionSchemaParser.class );
+
/**
* Creates a schema parser instance.
*/
@@ -68,7 +69,7 @@ public class NameFormDescriptionSchemaPa
* @return the parsed NameForm bean
* @throws ParseException if there are any recognition errors (bad syntax)
*/
- public synchronized NameForm parseNameFormDescription( String nameFormDescription)
+ public synchronized NameForm parseNameFormDescription( String nameFormDescription )
throws ParseException
{
LOG.debug( "Parsing a NameForm : {}", nameFormDescription );
@@ -84,7 +85,7 @@ public class NameFormDescriptionSchemaPa
try
{
NameForm nameForm = parser.nameFormDescription();
-
+
// Update the schemaName
updateSchemaName( nameForm );
@@ -106,10 +107,11 @@ public class NameFormDescriptionSchemaPa
/**
- * Parses a NameForm description
+ * Parses a NameForm description.
*
* @param schemaDescription The NameForm description to parse
* @return An instance of NameForm
+ * @throws ParseException {@inheritDoc}
*/
public NameForm parse( String schemaDescription ) throws ParseException
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/NormalizerDescription.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/NormalizerDescription.java?rev=1004355&r1=1004354&r2=1004355&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/NormalizerDescription.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/NormalizerDescription.java Mon Oct 4 18:44:51 2010
@@ -47,7 +47,7 @@ public class NormalizerDescription exten
/**
- * @see Object#toString()
+ * {@inheritDoc}
*/
public String toString()
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/NormalizerDescriptionSchemaParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/NormalizerDescriptionSchemaParser.java?rev=1004355&r1=1004354&r2=1004355&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/NormalizerDescriptionSchemaParser.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/NormalizerDescriptionSchemaParser.java Mon Oct 4 18:44:51 2010
@@ -113,10 +113,11 @@ public class NormalizerDescriptionSchema
/**
- * Parses a Normalizer description
+ * Parses a Normalizer description.
*
* @param schemaDescription The Normalizer description to parse
* @return An instance of NormalizerDescription
+ * @throws ParseException {@inheritDoc}
*/
public NormalizerDescription parse( String schemaDescription ) throws ParseException
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/ObjectClassDescriptionSchemaParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/ObjectClassDescriptionSchemaParser.java?rev=1004355&r1=1004354&r2=1004355&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/ObjectClassDescriptionSchemaParser.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/ObjectClassDescriptionSchemaParser.java Mon Oct 4 18:44:51 2010
@@ -114,6 +114,13 @@ public class ObjectClassDescriptionSchem
}
+ /**
+ * Parses a ObjectClass description.
+ *
+ * @param schemaDescription The ObjectClass description to parse
+ * @return An instance of ObjectClass
+ * @throws ParseException {@inheritDoc}
+ */
public ObjectClass parse( String schemaDescription ) throws ParseException
{
return parseObjectClassDescription( schemaDescription );
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/ReusableAntlrSchemaParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/ReusableAntlrSchemaParser.java?rev=1004355&r1=1004354&r2=1004355&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/ReusableAntlrSchemaParser.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/ReusableAntlrSchemaParser.java Mon Oct 4 18:44:51 2010
@@ -19,10 +19,12 @@
*/
package org.apache.directory.shared.ldap.schema.parsers;
+
import org.apache.directory.shared.ldap.schema.syntax.AntlrSchemaParser;
import antlr.TokenStream;
+
/**
* A reusable parser class extended from antlr generated parser for an LDAP
* schema as defined in RFC 4512. This class
@@ -35,8 +37,11 @@ import antlr.TokenStream;
*/
public class ReusableAntlrSchemaParser extends AntlrSchemaParser
{
+
/**
* Creates a ReusableAntlrSchemaParser instance.
+ *
+ * @param lexer the lexer
*/
public ReusableAntlrSchemaParser( TokenStream lexer )
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/SyntaxCheckerDescription.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/SyntaxCheckerDescription.java?rev=1004355&r1=1004354&r2=1004355&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/SyntaxCheckerDescription.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/SyntaxCheckerDescription.java Mon Oct 4 18:44:51 2010
@@ -47,7 +47,7 @@ public class SyntaxCheckerDescription ex
/**
- * @see Object#toString()
+ * {@inheritDoc}
*/
public String toString()
{
Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/SyntaxCheckerDescriptionSchemaParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/SyntaxCheckerDescriptionSchemaParser.java?rev=1004355&r1=1004354&r2=1004355&view=diff
==============================================================================
--- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/SyntaxCheckerDescriptionSchemaParser.java (original)
+++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/schema/parsers/SyntaxCheckerDescriptionSchemaParser.java Mon Oct 4 18:44:51 2010
@@ -116,6 +116,7 @@ public class SyntaxCheckerDescriptionSch
*
* @param schemaDescription The SyntaxChecker description to parse
* @return An instance of SyntaxCheckerDescription
+ * @throws ParseException {@inheritDoc}
*/
public SyntaxCheckerDescription parse( String schemaDescription ) throws ParseException
{