Class 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
     
    Author:
    Middleware Services
    • Constructor Detail

      • NameForm

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

        public NameForm​(java.lang.String oid,
                        java.lang.String[] names,
                        java.lang.String description,
                        boolean obsolete,
                        java.lang.String structuralClass,
                        java.lang.String[] requiredAttributes,
                        java.lang.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 Detail

      • getOID

        public java.lang.String getOID()
        Returns the oid.
        Returns:
        oid
      • getStructuralClass

        public java.lang.String getStructuralClass()
        Returns the structural object class.
        Returns:
        structural object class
      • setStructuralClass

        public void setStructuralClass​(java.lang.String s)
        Sets the structural object class.
        Parameters:
        s - structural object class
      • getRequiredAttributes

        public java.lang.String[] getRequiredAttributes()
        Returns the required attributes.
        Returns:
        required attributes
      • setRequiredAttributes

        public void setRequiredAttributes​(java.lang.String[] s)
        Sets the required attributes.
        Parameters:
        s - required attributes
      • getOptionalAttributes

        public java.lang.String[] getOptionalAttributes()
        Returns the optional attributes.
        Returns:
        optional attributes
      • setOptionalAttributes

        public void setOptionalAttributes​(java.lang.String[] s)
        Sets the optional attributes.
        Parameters:
        s - optional attributes
      • parse

        public static NameForm parse​(java.lang.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 java.lang.String format()
        Description copied from interface: SchemaElement
        Returns this schema element as formatted string per RFC 4512.
        Returns:
        formatted string
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object