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

Class ObjectClassDescriptionSyntaxChecker

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

All Implemented Interfaces:

Serializable, SchemaObject

public final class ObjectClassDescriptionSyntaxChecker
extends SyntaxChecker

A SyntaxChecker which verifies that a value follows the object class descripton syntax according to RFC 4512, par 4.2.1:

 ObjectClassDescription = LPAREN WSP
     numericoid                 ; object identifier
     [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
     [ SP "DESC" SP qdstring ]  ; description
     [ SP "OBSOLETE" ]          ; not active
     [ SP "SUP" SP oids ]       ; superior object classes
     [ SP kind ]                ; kind of class
     [ SP "MUST" SP oids ]      ; attribute types
     [ SP "MAY" SP oids ]       ; attribute types
     extensions WSP RPAREN

 kind = "ABSTRACT" / "STRUCTURAL" / "AUXILIARY"
 
 extensions = *( SP xstring SP qdstrings )
 xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
 

Author:

Apache Directory Project

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObjectClassDescriptionSyntaxChecker.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 ObjectClassDescriptionSyntaxChecker	INSTANCE A static instance of ObjectClassDescriptionSyntaxChecker
private ObjectClassDescriptionSchemaParser	schemaParser The schema parser used to parse the ObjectClassDescription 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	ObjectClassDescriptionSyntaxChecker(String oid) Creates a new instance of ObjectClassDescriptionSyntaxChecker.

Method Summary

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

The schema parser used to parse the ObjectClassDescription Syntax

INSTANCE

public static final ObjectClassDescriptionSyntaxChecker INSTANCE

A static instance of ObjectClassDescriptionSyntaxChecker

Constructor Detail

ObjectClassDescriptionSyntaxChecker

private ObjectClassDescriptionSyntaxChecker(String oid)

Creates a new instance of ObjectClassDescriptionSyntaxChecker.

Parameters:

oid - The OID to use for this SyntaxChecker

Method Detail

builder

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