|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.schema.SchemaElement
com.unboundid.ldap.sdk.schema.MatchingRuleUseDefinition
public final class MatchingRuleUseDefinition
This class provides a data structure that describes an LDAP matching rule use schema element.
Constructor Summary | |
---|---|
MatchingRuleUseDefinition(java.lang.String s)
Creates a new matching rule use from the provided string representation. |
|
MatchingRuleUseDefinition(java.lang.String oid,
java.lang.String[] names,
java.lang.String description,
boolean isObsolete,
java.lang.String[] applicableTypes,
java.util.Map<java.lang.String,java.lang.String[]> extensions)
Creates a new matching rule use with the provided information. |
|
MatchingRuleUseDefinition(java.lang.String oid,
java.lang.String name,
java.lang.String description,
java.util.Collection<java.lang.String> applicableTypes,
java.util.Map<java.lang.String,java.lang.String[]> extensions)
Creates a new matching rule use with the provided information. |
|
MatchingRuleUseDefinition(java.lang.String oid,
java.lang.String name,
java.lang.String description,
java.lang.String[] applicableTypes,
java.util.Map<java.lang.String,java.lang.String[]> extensions)
Creates a new matching rule use with the provided information. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this schema element. |
java.lang.String[] |
getApplicableAttributeTypes()
Retrieves the names or OIDs of the attribute types to which this matching rule use applies. |
java.lang.String |
getDescription()
Retrieves the description for this matching rule use, if available. |
java.util.Map<java.lang.String,java.lang.String[]> |
getExtensions()
Retrieves the set of extensions for this matching rule use. |
java.lang.String |
getNameOrOID()
Retrieves the primary name that can be used to reference this matching rule use. |
java.lang.String[] |
getNames()
Retrieves the set of names for this matching rule use. |
java.lang.String |
getOID()
Retrieves the OID for this matching rule use. |
int |
hashCode()
Retrieves a hash code for this schema element. |
boolean |
hasNameOrOID(java.lang.String s)
Indicates whether the provided string matches the OID or any of the names for this matching rule use. |
boolean |
isObsolete()
Indicates whether this matching rule use is declared obsolete. |
java.lang.String |
toString()
Retrieves a string representation of this matching rule definition, in the format described in RFC 4512 section 4.1.4. |
Methods inherited from class com.unboundid.ldap.sdk.schema.SchemaElement |
---|
extensionsEqual |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public MatchingRuleUseDefinition(java.lang.String s) throws LDAPException
s
- The string representation of the matching rule use to create,
using the syntax described in RFC 4512 section 4.1.4. It must
not be null
.
LDAPException
- If the provided string cannot be decoded as a
matching rule use definition.public MatchingRuleUseDefinition(java.lang.String oid, java.lang.String name, java.lang.String description, java.lang.String[] applicableTypes, java.util.Map<java.lang.String,java.lang.String[]> extensions)
oid
- The OID for this matching rule use. It must not
be null
.name
- The name for this matching rule use. It may be
null
or empty if the matching rule use
should only be referenced by OID.description
- The description for this matching rule use. It
may be null
if there is no description.applicableTypes
- The set of attribute types to which this matching
rule use applies. It must not be empty or
null
.extensions
- The set of extensions for this matching rule use.
It may be null
or empty if there should
not be any extensions.public MatchingRuleUseDefinition(java.lang.String oid, java.lang.String name, java.lang.String description, java.util.Collection<java.lang.String> applicableTypes, java.util.Map<java.lang.String,java.lang.String[]> extensions)
oid
- The OID for this matching rule use. It must not
be null
.name
- The name for this matching rule use. It may be
null
or empty if the matching rule use
should only be referenced by OID.description
- The description for this matching rule use. It
may be null
if there is no description.applicableTypes
- The set of attribute types to which this matching
rule use applies. It must not be empty or
null
.extensions
- The set of extensions for this matching rule use.
It may be null
or empty if there should
not be any extensions.public MatchingRuleUseDefinition(java.lang.String oid, java.lang.String[] names, java.lang.String description, boolean isObsolete, java.lang.String[] applicableTypes, java.util.Map<java.lang.String,java.lang.String[]> extensions)
oid
- The OID for this matching rule use. It must not
be null
.names
- The set of names for this matching rule use. It
may be null
or empty if the matching rule
use should only be referenced by OID.description
- The description for this matching rule use. It
may be null
if there is no description.isObsolete
- Indicates whether this matching rule use is
declared obsolete.applicableTypes
- The set of attribute types to which this matching
rule use applies. It must not be empty or
null
.extensions
- The set of extensions for this matching rule use.
It may be null
or empty if there should
not be any extensions.Method Detail |
---|
public java.lang.String getOID()
public java.lang.String[] getNames()
public java.lang.String getNameOrOID()
public boolean hasNameOrOID(java.lang.String s)
s
- The string for which to make the determination. It must not be
null
.
true
if the provided string matches the OID or any of the
names for this matching rule use, or false
if not.public java.lang.String getDescription()
null
if
there is no description defined.public boolean isObsolete()
true
if this matching rule use is declared obsolete, or
false
if it is not.public java.lang.String[] getApplicableAttributeTypes()
public java.util.Map<java.lang.String,java.lang.String[]> getExtensions()
public int hashCode()
hashCode
in class SchemaElement
public boolean equals(java.lang.Object o)
equals
in class SchemaElement
o
- The object for which to make the determination.
true
if the provided object may be considered equal to
this schema element, or false
if not.public java.lang.String toString()
toString
in class SchemaElement
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |