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

Class DitStructureRuleDescriptionSyntaxChecker

java.lang.Object

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

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

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

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

All Implemented Interfaces:

Serializable, SchemaObject

public final class DitStructureRuleDescriptionSyntaxChecker
extends SyntaxChecker

A SyntaxChecker which verifies that a value follows the DIT structure rule descripton syntax according to RFC 4512, par 4.2.7.1:

 DITStructureRuleDescription = LPAREN WSP
   ruleid                     ; rule identifier
   [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
   [ SP "DESC" SP qdstring ]  ; description
   [ SP "OBSOLETE" ]          ; not active
   SP "FORM" SP oid           ; NameForm
   [ SP "SUP" ruleids ]       ; superior rules
   extensions WSP RPAREN      ; extensions

 ruleids = ruleid / ( LPAREN WSP ruleidlist WSP RPAREN )
 ruleidlist = ruleid *( SP ruleid )
 ruleid = numbers
 

Author:

Apache Directory Project

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DitStructureRuleDescriptionSyntaxChecker.Builder A static Builder for this class

Nested classes/interfaces inherited from class org.apache.directory.api.ldap.model.schema.SyntaxChecker

SyntaxChecker.SCBuilder<SC>

Field Summary

Fields

Modifier and Type	Field and Description
static DitStructureRuleDescriptionSyntaxChecker	INSTANCE A static instance of DitStructureRuleDescriptionSyntaxChecker
private DitStructureRuleDescriptionSchemaParser	schemaParser The schema parser used to parse the DITContentRuleDescription Syntax

Fields inherited from class org.apache.directory.api.ldap.model.schema.SyntaxChecker

LOG, serialVersionUID

Fields inherited from class org.apache.directory.api.ldap.model.schema.AbstractSchemaObject

description, extensions, h, isEnabled, isObsolete, locked, names, objectType, oid, schemaName, specification

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DitStructureRuleDescriptionSyntaxChecker(String oid) Creates a new instance of DITContentRuleDescriptionSyntaxChecker.

Method Summary

Modifier and Type	Method and Description
static DitStructureRuleDescriptionSyntaxChecker.Builder	builder()
boolean	isValidSyntax(Object value) Determines if the attribute's value conforms to the attribute syntax.

Methods inherited from class org.apache.directory.api.ldap.model.schema.SyntaxChecker

equals, setSchemaManager, toString

Methods inherited from class org.apache.directory.api.ldap.model.schema.LoadableSchemaObject

copy, getBytecode, getFqcn, hashCode, isValid, setBytecode, setFqcn

Methods inherited from class org.apache.directory.api.ldap.model.schema.AbstractSchemaObject

addExtension, addExtension, addName, clear, compareOid, computeHashCode, copy, getDescription, getExtension, getExtensions, getName, getNames, getObjectType, getOid, getSchemaName, getSpecification, hasExtension, isDisabled, isEnabled, isObsolete, lock, setDescription, setEnabled, setExtensions, setNames, setNames, setObsolete, setOid, setSchemaName, setSpecification, unlock

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

schemaParser

private transient DitStructureRuleDescriptionSchemaParser schemaParser

The schema parser used to parse the DITContentRuleDescription Syntax

INSTANCE

public static final DitStructureRuleDescriptionSyntaxChecker INSTANCE

A static instance of DitStructureRuleDescriptionSyntaxChecker

Constructor Detail

DitStructureRuleDescriptionSyntaxChecker

private DitStructureRuleDescriptionSyntaxChecker(String oid)

Creates a new instance of DITContentRuleDescriptionSyntaxChecker.

Parameters:

oid - The OID to use for this SyntaxChecker

Method Detail

builder

public static DitStructureRuleDescriptionSyntaxChecker.Builder builder()

Returns:

An instance of the Builder for this class

isValidSyntax

public boolean isValidSyntax(Object value)

Determines if the attribute's value conforms to the attribute syntax.

Overrides:

isValidSyntax in class SyntaxChecker

Parameters:

value - the value of some attribute with the syntax

Returns:

true if the value is in the valid syntax, false otherwise