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

Class NameFormDescriptionSyntaxChecker

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.NameFormDescriptionSyntaxChecker

All Implemented Interfaces:

Serializable, SchemaObject

public final class NameFormDescriptionSyntaxChecker
extends SyntaxChecker

A SyntaxChecker which verifies that a value follows the name descripton syntax according to RFC 4512, par 4.2.7.2:

 NameFormDescription = LPAREN WSP
    numericoid                 ; object identifier
    [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
    [ SP "DESC" SP qdstring ]  ; description
    [ SP "OBSOLETE" ]          ; not active
    SP "OC" SP oid             ; structural object class
    SP "MUST" SP oids          ; attribute types
    [ SP "MAY" SP oids ]       ; attribute types
    extensions WSP RPAREN      ; extensions
 

Author:

Apache Directory Project

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NameFormDescriptionSyntaxChecker.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 NameFormDescriptionSyntaxChecker	INSTANCE A static instance of NameFormDescriptionSyntaxChecker
private NameFormDescriptionSchemaParser	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	NameFormDescriptionSyntaxChecker(String oid) Creates a new instance of DITContentRuleDescriptionSyntaxChecker.

Method Summary

Modifier and Type	Method and Description
static NameFormDescriptionSyntaxChecker.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 NameFormDescriptionSchemaParser schemaParser

The schema parser used to parse the DITContentRuleDescription Syntax

INSTANCE

public static final NameFormDescriptionSyntaxChecker INSTANCE

A static instance of NameFormDescriptionSyntaxChecker

Constructor Detail

NameFormDescriptionSyntaxChecker

private NameFormDescriptionSyntaxChecker(String oid)

Creates a new instance of DITContentRuleDescriptionSyntaxChecker.

Parameters:

oid - The OID to use for this SyntaxChecker

Method Detail

builder

public static NameFormDescriptionSyntaxChecker.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