java.lang.Object

org.ldaptive.schema.AbstractSchemaElement

org.ldaptive.schema.Syntax

All Implemented Interfaces:: SchemaElement

public class Syntax extends AbstractSchemaElement

Bean for an attribute syntax schema element.

   SyntaxDescription = LPAREN WSP
     numericoid                 ; object identifier
     [ SP "DESC" SP qdstring ]  ; description
     extensions WSP RPAREN      ; extensions

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

Syntax.DefaultDefinitionFunction

Parses a syntax definition using a char buffer.

static class

Syntax.RegexDefinitionFunction

Parses a syntax definition using a regular expression.
Field Summary

Fields

Modifier and Type

Field

Description

private static final int

HASH_CODE_SEED

hash code seed.

private final String

oid

OID.
Constructor Summary

Constructors

Constructor

Description

Syntax(String s)

Creates a new attribute syntax.

Syntax(String oid, String description, Extensions extensions)

Creates a new attribute syntax.
Method Summary

Modifier and Type

Method

Description

boolean

equals(Object o)

String

format()

Returns this schema element as formatted string per RFC 4512.

String

getOID()

Returns the oid.

int

hashCode()

static Syntax

parse(String definition)

Parses the supplied definition string and creates an initialized attribute syntax.

String

toString()

Methods inherited from class org.ldaptive.schema.AbstractSchemaElement
containsBooleanExtension, getDescription, getExtensions, setDescription, setExtensions

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details
- HASH_CODE_SEED
  
  private static final int HASH_CODE_SEED
  
  hash code seed.
  See Also:
  
  Constant Field Values
- oid
  
  private final String oid
  
  OID.
Constructor Details
- Syntax
  
  public Syntax(String s)
  
  Creates a new attribute syntax.
  
  Parameters:
  
  s - oid
- Syntax
  
  public Syntax(String oid, String description, Extensions extensions)
  
  Creates a new attribute syntax.
  
  Parameters:
  
  oid - oid
  
  description - description
  
  extensions - extensions
Method Details
- getOID
  
  public String getOID()
  
  Returns the oid.
  
  Returns:
  
  oid
- parse
  
  public static Syntax parse(String definition) throws SchemaParseException
  
  Parses the supplied definition string and creates an initialized attribute syntax.
  
  Parameters:
  
  definition - to parse
  
  Returns:
  
  attribute syntax
  
  Throws:
  
  SchemaParseException - if the supplied definition is invalid
- format
  
  public String format()
  
  Description copied from interface: SchemaElement
  
  Returns this schema element as formatted string per RFC 4512.
  
  Returns:
  
  formatted string
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class AbstractSchemaElement
- hashCode
  
  public int hashCode()
  
  Specified by:
  
  hashCode in class AbstractSchemaElement
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object

Class Syntax

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.ldaptive.schema.AbstractSchemaElement

Methods inherited from class java.lang.Object

Field Details

HASH_CODE_SEED

oid

Constructor Details

Syntax

Syntax

Method Details

getOID

parse

format

equals

hashCode

toString