org.forgerock.opendj.ldap.schema

Class DitStructureRule

java.lang.Object

org.forgerock.opendj.ldap.schema.DitStructureRule

All Implemented Interfaces:

SchemaElement

public final class DitStructureRule
extends Object

This class defines a DIT structure rule, which is used to indicate the types of children that entries may have.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DitStructureRule.Builder A fluent API for incrementally constructing DIT structure rules.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Returns true if the provided object is a DIT structure rule having the same rule ID as this DIT structure rule.
String	getDescription() Returns the description of this schema element, or the empty string if it does not have a description.
Map<String,List<String>>	getExtraProperties() Returns an unmodifiable map containing all of the extra properties associated with this schema element.
NameForm	getNameForm() Retrieves the name form for this DIT structure rule.
String	getNameOrRuleId() Retrieves the name or rule ID for this schema definition.
List<String>	getNames() Returns an unmodifiable list containing the user-defined names that may be used to reference this schema definition.
Integer	getRuleId() Retrieves the rule ID for this DIT structure rule.
Set<DitStructureRule>	getSuperiorRules() Returns an unmodifiable set containing the superior rules for this DIT structure rule.
int	hashCode() Returns the hash code for this DIT structure rule.
boolean	hasName(String name) Indicates whether this schema definition has the specified name.
boolean	isObsolete() Indicates whether this schema definition is declared "obsolete".
String	toString() Returns the string representation of this schema element as defined in RFC 2252.

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(Object o)

Returns true if the provided object is a DIT structure rule having the same rule ID as this DIT structure rule.

Parameters:

o - The object to be compared.

Returns:

true if the provided object is a DIT structure rule having the same rule ID as this DIT structure rule.

getNameForm

public NameForm getNameForm()

Retrieves the name form for this DIT structure rule.

Returns:

The name form for this DIT structure rule.

getNameOrRuleId

public String getNameOrRuleId()

Retrieves the name or rule ID for this schema definition. If it has one or more names, then the primary name will be returned. If it does not have any names, then the OID will be returned.

Returns:

The name or OID for this schema definition.

getNames

public List<String> getNames()

Returns an unmodifiable list containing the user-defined names that may be used to reference this schema definition.

Returns:

Returns an unmodifiable list containing the user-defined names that may be used to reference this schema definition.

getRuleId

public Integer getRuleId()

Retrieves the rule ID for this DIT structure rule.

Returns:

The rule ID for this DIT structure rule (never null).

getSuperiorRules

public Set<DitStructureRule> getSuperiorRules()

Returns an unmodifiable set containing the superior rules for this DIT structure rule.

Returns:

An unmodifiable set containing the superior rules for this DIT structure rule.

hashCode

public int hashCode()

Returns the hash code for this DIT structure rule. It will be calculated as the hash code of the rule ID.

Returns:

The hash code for this DIT structure rule.

hasName

public boolean hasName(String name)

Indicates whether this schema definition has the specified name.

Parameters:

name - The name for which to make the determination.

Returns:

true if the specified name is assigned to this schema definition, or false if not.

isObsolete

public boolean isObsolete()

Indicates whether this schema definition is declared "obsolete".

Returns:

true if this schema definition is declared "obsolete", or false if not.

getDescription

public final String getDescription()

Description copied from interface: SchemaElement

Returns the description of this schema element, or the empty string if it does not have a description.

Specified by:

getDescription in interface SchemaElement

Returns:

The description of this schema element, or the empty string if it does not have a description.

getExtraProperties

public final Map<String,List<String>> getExtraProperties()

Description copied from interface: SchemaElement

Returns an unmodifiable map containing all of the extra properties associated with this schema element.

Specified by:

getExtraProperties in interface SchemaElement

Returns:

An unmodifiable map containing all of the extra properties associated with this schema element.

toString

public final String toString()

Returns the string representation of this schema element as defined in RFC 2252.

Overrides:

toString in class Object

Returns:

The string representation of this schema element as defined in RFC 2252.