Package org.ldaptive.schema
Class DITStructureRule
java.lang.Object
org.ldaptive.schema.AbstractSchemaElement
org.ldaptive.schema.AbstractNamedSchemaElement
org.ldaptive.schema.DITStructureRule
- All Implemented Interfaces:
SchemaElement
Bean for a DIT content rule schema element.
DITStructureRuleDescription = LPAREN WSP ruleid ; rule identifier [ SP "NAME" SP qdescrs ] ; short names (descriptors) [ SP "DESC" SP qdstring ] ; description [ SP "OBSOLETE" ] ; not active SP "FORM" SP oid ; NameForm [ SP "SUP" ruleids ] ; superior rules extensions WSP RPAREN ; extensions
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Parses a DIT structure rule definition using a char buffer.static class
Parses a DIT structure rule definition using a regular expression. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
hash code seed.private final int
ID.private String
Name form.private int[]
Superior rules. -
Constructor Summary
ConstructorsConstructorDescriptionDITStructureRule
(int i) Creates a new DIT structure rule.DITStructureRule
(int id, String[] names, String description, boolean obsolete, String nameForm, int[] superiorRules, Extensions extensions) Creates a new DIT structure rule. -
Method Summary
Modifier and TypeMethodDescriptionboolean
format()
Returns this schema element as formatted string per RFC 4512.int
getID()
Returns the id.Returns the name form.int[]
Returns the superior rules.int
hashCode()
static DITStructureRule
Parses the supplied definition string and creates an initialized DIT structure rule.void
Sets the name form.void
setSuperiorRules
(int[] i) Sets the superior rules.toString()
Methods inherited from class org.ldaptive.schema.AbstractNamedSchemaElement
getName, getNames, hasName, isObsolete, setNames, setObsolete
Methods inherited from class org.ldaptive.schema.AbstractSchemaElement
containsBooleanExtension, getDescription, getExtensions, setDescription, setExtensions
-
Field Details
-
HASH_CODE_SEED
private static final int HASH_CODE_SEEDhash code seed.- See Also:
-
id
private final int idID. -
nameForm
Name form. -
superiorRules
private int[] superiorRulesSuperior rules.
-
-
Constructor Details
-
DITStructureRule
public DITStructureRule(int i) Creates a new DIT structure rule.- Parameters:
i
- id
-
DITStructureRule
public DITStructureRule(int id, String[] names, String description, boolean obsolete, String nameForm, int[] superiorRules, Extensions extensions) Creates a new DIT structure rule.- Parameters:
id
- idnames
- namesdescription
- descriptionobsolete
- obsoletenameForm
- name formsuperiorRules
- superior rulesextensions
- extensions
-
-
Method Details
-
getID
public int getID()Returns the id.- Returns:
- id
-
getNameForm
Returns the name form.- Returns:
- name form
-
setNameForm
Sets the name form.- Parameters:
s
- name form
-
getSuperiorRules
public int[] getSuperiorRules()Returns the superior rules.- Returns:
- superior rules
-
setSuperiorRules
public void setSuperiorRules(int[] i) Sets the superior rules.- Parameters:
i
- superior rules
-
parse
Parses the supplied definition string and creates an initialized DIT structure rule.- Parameters:
definition
- to parse- Returns:
- DIT structure rule
- Throws:
SchemaParseException
- if the supplied definition is invalid
-
format
Description copied from interface:SchemaElement
Returns this schema element as formatted string per RFC 4512.- Returns:
- formatted string
-
equals
- Overrides:
equals
in classAbstractSchemaElement
-
hashCode
public int hashCode()- Specified by:
hashCode
in classAbstractSchemaElement
-
toString
-