org.apache.directory.api.ldap.model.schema

Class DescriptionUtils

java.lang.Object

org.apache.directory.api.ldap.model.schema.DescriptionUtils

public final class DescriptionUtils
extends java.lang.Object

Utility class used to generate schema object specifications. Some of the latest work coming out of the LDAPBIS working body adds optional extensions to these syntaxes. Descriptions can be generated for the following objects:

• AttributeType
• DitContentRule
• DitStructureRule
• Syntax
• MatchingRule
• MatchingRuleUse
• NameForm
• Syntax
• ObjectClass
• Syntax
• Syntax

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DescriptionUtils() Private constructor.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getDescription(LdapComparator<?> comparator) Generates the ComparatorDescription for a LdapComparator.
static java.lang.String	getDescription(Normalizer normalizer) Generates the NormalizerDescription for a Normalizer.
static java.lang.String	getDescription(SyntaxChecker syntaxChecker) Generates the SyntaxCheckerDescription for a SyntaxChecker.
private static void	getExtensions(java.lang.StringBuilder sb, java.util.Map<java.lang.String,java.util.List<java.lang.String>> extensions)
private static java.lang.String	getLoadableDescription(LoadableSchemaObject schemaObject) Generate the description for Comparators, Normalizers and SyntaxCheckers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DescriptionUtils

private DescriptionUtils()

Private constructor.

Method Detail

getDescription

public static java.lang.String getDescription(LdapComparator<?> comparator)

Generates the ComparatorDescription for a LdapComparator. Only the right hand side of the description starting at the opening parenthesis is generated: that is 'ComparatorDescription = ' is not generated.

 ComparatorDescription = "("
     numericoid                          
     ["DESC" qdstring ]
     "FQCN" whsp fqcn
     ["BYTECODE" whsp base64  ]
     extensions 
     ")"
 

Parameters:

comparator - the Comparator to generate the description for

Returns:

the ComparatorDescription string

getDescription

public static java.lang.String getDescription(Normalizer normalizer)

Generates the NormalizerDescription for a Normalizer. Only the right hand side of the description starting at the opening parenthesis is generated: that is 'NormalizerDescription = ' is not generated.

 NormalizerDescription = "("
     numericoid                          
     ["DESC" qdstring ]
     "FQCN" whsp fqcn
     ["BYTECODE" whsp base64  ]
     extensions 
     ")"
 

Parameters:

normalizer - the Normalizer to generate the description for

Returns:

the NormalizerDescription string

getDescription

public static java.lang.String getDescription(SyntaxChecker syntaxChecker)

Generates the SyntaxCheckerDescription for a SyntaxChecker. Only the right hand side of the description starting at the opening parenthesis is generated: that is 'SyntaxCheckerDescription = ' is not generated.

 SyntaxCheckerDescription = "("
     numericoid                          
     ["DESC" qdstring ]
     "FQCN" whsp fqcn
     ["BYTECODE" whsp base64  ]
     extensions 
     ")"
 

Parameters:

syntaxChecker - the SyntaxChecker to generate the description for

Returns:

the SyntaxCheckerDescription string

getExtensions

private static void getExtensions(java.lang.StringBuilder sb,
                                  java.util.Map<java.lang.String,java.util.List<java.lang.String>> extensions)

getLoadableDescription

private static java.lang.String getLoadableDescription(LoadableSchemaObject schemaObject)

Generate the description for Comparators, Normalizers and SyntaxCheckers.