netscape.ldap
Class LDAPSyntaxSchemaElement

java.lang.Object
  extended by netscape.ldap.LDAPSchemaElement
      extended by netscape.ldap.LDAPSyntaxSchemaElement
All Implemented Interfaces:
java.io.Serializable

 class LDAPSyntaxSchemaElement
extends LDAPSchemaElement

Helper class supporting schema elements that include syntax definitions - attributes and matching rules

Version:
1.0
See Also:
LDAPAttributeSchema, LDAPMatchingRuleSchema

Field Summary
(package private) static long serialVersionUID
           
(package private)  int syntax
           
(package private)  java.lang.String syntaxString
           
 
Fields inherited from class netscape.ldap.LDAPSchemaElement
aliases, attrName, binary, binaryString, ces, cesString, cis, cisString, description, dn, dnString, integer, intString, name, novalsTable, OBSOLETE, oid, properties, rawValue, SUPERIOR, SYNTAX, telephone, telephoneString, unknown
 
Constructor Summary
LDAPSyntaxSchemaElement()
          Construct a blank element.
 
Method Summary
(package private)  int getSyntax()
          Gets the syntax of the schema element
(package private)  java.lang.String getSyntaxString()
          Gets the syntax of the attribute type in dotted-decimal format, for example "1.2.3.4.5"
(package private) static java.lang.String internalSyntaxToString(int syntax)
          Convert from enumerated syntax types to an OID
(package private)  int syntaxCheck(java.lang.String syntax)
          Convert from an OID to one of the enumerated syntax types
(package private)  java.lang.String syntaxToString()
          Convert from enumerated syntax type to a user-friendly string
 
Methods inherited from class netscape.ldap.LDAPSchemaElement
add, add, getAliases, getAliasString, getCustomValues, getDescription, getID, getName, getOID, getOptionalValues, getQualifier, getQualifierNames, getQualifierString, getValue, getValue, getValue, getValue, getValuePrefix, isObsolete, modify, modify, parseValue, remove, remove, setQualifier, setQualifier, update, update, update
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

syntax

int syntax

syntaxString

java.lang.String syntaxString
Constructor Detail

LDAPSyntaxSchemaElement

LDAPSyntaxSchemaElement()
Construct a blank element.

Method Detail

getSyntax

int getSyntax()
Gets the syntax of the schema element

Returns:
One of the following values:
  • cis (case-insensitive string)
  • ces (case-exact string)
  • binary (binary data)
  • int (integer)
  • telephone (telephone number -- identical to cis, but blanks and dashes are ignored during comparisons)
  • dn (distinguished name)
  • unknown (not a known syntax)

getSyntaxString

java.lang.String getSyntaxString()
Gets the syntax of the attribute type in dotted-decimal format, for example "1.2.3.4.5"

Returns:
The attribute syntax in dotted-decimal format.

internalSyntaxToString

static java.lang.String internalSyntaxToString(int syntax)
Convert from enumerated syntax types to an OID

Parameters:
syntax - One of the enumerated syntax types
Returns:
The OID corresponding to the internal type

syntaxToString

java.lang.String syntaxToString()
Convert from enumerated syntax type to a user-friendly string

Parameters:
syntax - One of the enumerated syntax types
Returns:
A user-friendly syntax description

syntaxCheck

int syntaxCheck(java.lang.String syntax)
Convert from an OID to one of the enumerated syntax types

Parameters:
syntax - A dotted-decimal OID
Returns:
The internal enumerated type corresponding to the OID; unknown if it is not one of the known types