org.ldaptive.schema

Class AttributeType

java.lang.Object

org.ldaptive.schema.AbstractSchemaElement

org.ldaptive.schema.AbstractNamedSchemaElement

org.ldaptive.schema.AttributeType

All Implemented Interfaces:

SchemaElement

public class AttributeType
extends AbstractNamedSchemaElement

Bean for an attribute type schema element.

   AttributeTypeDescription = LPAREN WSP
     numericoid                    ; object identifier
     [ SP "NAME" SP qdescrs ]      ; short names (descriptors)
     [ SP "DESC" SP qdstring ]     ; description
     [ SP "OBSOLETE" ]             ; not active
     [ SP "SUP" SP oid ]           ; supertype
     [ SP "EQUALITY" SP oid ]      ; equality matching rule
     [ SP "ORDERING" SP oid ]      ; ordering matching rule
     [ SP "SUBSTR" SP oid ]        ; substrings matching rule
     [ SP "SYNTAX" SP noidlen ]    ; value syntax
     [ SP "SINGLE-VALUE" ]         ; single-value
     [ SP "COLLECTIVE" ]           ; collective
     [ SP "NO-USER-MODIFICATION" ] ; not user modifiable
     [ SP "USAGE" SP usage ]       ; usage
     extensions WSP RPAREN         ; extensions
 

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	collective Collective.
private static java.util.regex.Pattern	DEFINITION_PATTERN Pattern to match definitions.
private java.lang.String	equalityMatchingRule Equality matching rule.
private static int	HASH_CODE_SEED hash code seed.
private boolean	noUserModification No user modification.
private java.lang.String	oid OID.
private java.lang.String	orderingMatchingRule Ordering matching rule.
private boolean	singleValued Single valued.
private java.lang.String	substringMatchingRule Substring matching rule.
private java.lang.String	superiorType Superior type.
private java.lang.String	syntaxOID Syntax OID.
private AttributeUsage	usage Usage.

Fields inherited from class org.ldaptive.schema.AbstractSchemaElement

NO_WSP_REGEX, WSP_REGEX

Constructor Summary

Constructors

Constructor and Description
AttributeType(java.lang.String s) Creates a new attribute type.
AttributeType(java.lang.String oid, java.lang.String[] names, java.lang.String description, boolean obsolete, java.lang.String superiorType, java.lang.String equalityMatchingRule, java.lang.String orderingMatchingRule, java.lang.String substringMatchingRule, java.lang.String syntaxOID, boolean singleValued, boolean collective, boolean noUserModification, AttributeUsage usage, Extensions extensions) Creates a new attribute type.

Method Summary

Modifier and Type	Method and Description
java.lang.String	format() Returns this schema element as formatted string per RFC 4512.
java.lang.String	getEqualityMatchingRule() Returns the equality matching rule.
java.lang.String	getOID() Returns the oid.
java.lang.String	getOrderingMatchingRule() Returns the ordering matching rule.
java.lang.String	getSubstringMatchingRule() Returns the substring matching rule.
java.lang.String	getSuperiorType() Returns the superior type.
java.lang.String	getSyntaxOID() Returns the syntax oid.
java.lang.String	getSyntaxOID(boolean withBoundCount) Returns the syntax oid.
int	getSyntaxOIDBoundCount() Returns the syntax oid bound count.
AttributeUsage	getUsage() Returns the usage.
int	hashCode()
boolean	isCollective() Returns whether this attribute type is collective.
boolean	isNoUserModification() Returns whether this attribute type allows user modification.
boolean	isSingleValued() Returns whether this attribute type is single valued.
static AttributeType	parse(java.lang.String definition) Parses the supplied definition string and creates an initialized attribute type.
void	setCollective(boolean b) Sets whether this attribute type is collective.
void	setEqualityMatchingRule(java.lang.String s) Sets the equality matching rule.
void	setNoUserModification(boolean b) Sets whether this attribute type allows user modification.
void	setOrderingMatchingRule(java.lang.String s) Sets the ordering matching rule.
void	setSingleValued(boolean b) Sets whether this attribute type is single valued.
void	setSubstringMatchingRule(java.lang.String s) Sets the substring matching rule.
void	setSuperiorType(java.lang.String s) Sets the superior type.
void	setSyntaxOID(java.lang.String s) Sets the syntax oid.
void	setUsage(AttributeUsage u) Sets the usage.
java.lang.String	toString()

Methods inherited from class org.ldaptive.schema.AbstractNamedSchemaElement

getName, getNames, hasName, isObsolete, setNames, setObsolete

Methods inherited from class org.ldaptive.schema.AbstractSchemaElement

containsBooleanExtension, equals, getDescription, getExtensions, setDescription, setExtensions

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

Constant Field Values

DEFINITION_PATTERN

private static final java.util.regex.Pattern DEFINITION_PATTERN

Pattern to match definitions.

oid

private final java.lang.String oid

OID.

superiorType

private java.lang.String superiorType

Superior type.

equalityMatchingRule

private java.lang.String equalityMatchingRule

Equality matching rule.

orderingMatchingRule

private java.lang.String orderingMatchingRule

Ordering matching rule.

substringMatchingRule

private java.lang.String substringMatchingRule

Substring matching rule.

syntaxOID

private java.lang.String syntaxOID

Syntax OID.

singleValued

private boolean singleValued

Single valued.

collective

private boolean collective

Collective.

noUserModification

private boolean noUserModification

No user modification.

usage

private AttributeUsage usage

Usage.

Constructor Detail

AttributeType

public AttributeType(java.lang.String s)

Creates a new attribute type.

Parameters:

s - oid

AttributeType

public AttributeType(java.lang.String oid,
                     java.lang.String[] names,
                     java.lang.String description,
                     boolean obsolete,
                     java.lang.String superiorType,
                     java.lang.String equalityMatchingRule,
                     java.lang.String orderingMatchingRule,
                     java.lang.String substringMatchingRule,
                     java.lang.String syntaxOID,
                     boolean singleValued,
                     boolean collective,
                     boolean noUserModification,
                     AttributeUsage usage,
                     Extensions extensions)

Creates a new attribute type.

Parameters:

oid - oid

names - names

description - description

obsolete - obsolete

superiorType - superior type

equalityMatchingRule - equality matching rule

orderingMatchingRule - ordering matching rule

substringMatchingRule - substring matching rule

syntaxOID - syntax OID

singleValued - single valued

collective - collective

noUserModification - no user modification

usage - usage

extensions - extensions

Method Detail

getOID

public java.lang.String getOID()

Returns the oid.

Returns:

oid

getSuperiorType

public java.lang.String getSuperiorType()

Returns the superior type.

Returns:

superior type

setSuperiorType

public void setSuperiorType(java.lang.String s)

Sets the superior type.

Parameters:

s - superior type

getEqualityMatchingRule

public java.lang.String getEqualityMatchingRule()

Returns the equality matching rule.

Returns:

equality matching rule

setEqualityMatchingRule

public void setEqualityMatchingRule(java.lang.String s)

Sets the equality matching rule.

Parameters:

s - equality matching rule

getOrderingMatchingRule

public java.lang.String getOrderingMatchingRule()

Returns the ordering matching rule.

Returns:

ordering matching rule

setOrderingMatchingRule

public void setOrderingMatchingRule(java.lang.String s)

Sets the ordering matching rule.

Parameters:

s - ordering matching rule

getSubstringMatchingRule

public java.lang.String getSubstringMatchingRule()

Returns the substring matching rule.

Returns:

substring matching rule

setSubstringMatchingRule

public void setSubstringMatchingRule(java.lang.String s)

Sets the substring matching rule.

Parameters:

s - substring matching rule

getSyntaxOID

public java.lang.String getSyntaxOID()

Returns the syntax oid.

Returns:

syntax oid

getSyntaxOID

public java.lang.String getSyntaxOID(boolean withBoundCount)

Returns the syntax oid.

Parameters:

withBoundCount - whether the bound count should be included

Returns:

syntax oid

getSyntaxOIDBoundCount

public int getSyntaxOIDBoundCount()

Returns the syntax oid bound count.

Returns:

syntax oid bound count

setSyntaxOID

public void setSyntaxOID(java.lang.String s)

Sets the syntax oid.

Parameters:

s - syntax oid

isSingleValued

public boolean isSingleValued()

Returns whether this attribute type is single valued.

Returns:

whether this attribute type is single valued

setSingleValued

public void setSingleValued(boolean b)

Sets whether this attribute type is single valued.

Parameters:

b - whether this attribute type is single valued

isCollective

public boolean isCollective()

Returns whether this attribute type is collective.

Returns:

whether this attribute type is collective

setCollective

public void setCollective(boolean b)

Sets whether this attribute type is collective.

Parameters:

b - whether this attribute type is collective

isNoUserModification

public boolean isNoUserModification()

Returns whether this attribute type allows user modification.

Returns:

whether this attribute type allows user modification

setNoUserModification

public void setNoUserModification(boolean b)

Sets whether this attribute type allows user modification.

Parameters:

b - whether this attribute type allows user modification

getUsage

public AttributeUsage getUsage()

Returns the usage.

Returns:

usage

setUsage

public void setUsage(AttributeUsage u)

Sets the usage.

Parameters:

u - attribute usage

parse

public static AttributeType parse(java.lang.String definition)
                           throws java.text.ParseException

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

Parameters:

definition - to parse

Returns:

attribute type

Throws:

java.text.ParseException - 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

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractSchemaElement

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object