Package org.ldaptive.schema

Class NameForm

java.lang.Object
org.ldaptive.schema.AbstractSchemaElement
org.ldaptive.schema.AbstractNamedSchemaElement
org.ldaptive.schema.NameForm
All Implemented Interfaces:
SchemaElement
public class NameForm extends AbstractNamedSchemaElement
Bean for a name form schema element. 
   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

  • Field Details

    • HASH_CODE_SEED

      private static final int HASH_CODE_SEED
      hash code seed.
      See Also:

    • oid

      private final String oid
      OID.

    • structuralClass

      private String structuralClass
      Structural object class.

    • requiredAttributes

      private String[] requiredAttributes
      Required attributes.

    • optionalAttributes

      private String[] optionalAttributes
      Optional attributes.

  • Constructor Details

    • NameForm

      public NameForm(String s)
      Creates a new name form.
      Parameters:
      s - oid

    • NameForm

      public NameForm(String oid, String[] names, String description, boolean obsolete, String structuralClass, String[] requiredAttributes, String[] optionalAttributes, Extensions extensions)
      Creates a new name form.
      Parameters:
      oid - oid
      names - names
      description - description
      obsolete - obsolete
      structuralClass - structural object class
      requiredAttributes - required attributes
      optionalAttributes - optional attributes
      extensions - extensions

  • Method Details

    • getOID

      public String getOID()
      Returns the oid.
      Returns:
      oid

    • getStructuralClass

      public String getStructuralClass()
      Returns the structural object class.
      Returns:
      structural object class

    • setStructuralClass

      public void setStructuralClass(String s)
      Sets the structural object class.
      Parameters:
      s - structural object class

    • getRequiredAttributes

      public String[] getRequiredAttributes()
      Returns the required attributes.
      Returns:
      required attributes

    • setRequiredAttributes

      public void setRequiredAttributes(String[] s)
      Sets the required attributes.
      Parameters:
      s - required attributes

    • getOptionalAttributes

      public String[] getOptionalAttributes()
      Returns the optional attributes.
      Returns:
      optional attributes

    • setOptionalAttributes

      public void setOptionalAttributes(String[] s)
      Sets the optional attributes.
      Parameters:
      s - optional attributes

    • parse

      public static NameForm parse(String definition) throws SchemaParseException
      Parses the supplied definition string and creates an initialized name form.
      Parameters:
      definition - to parse
      Returns:
      name form
      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