|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.ldap.schema.AbstractSchemaObject
public abstract class AbstractSchemaObject
The abstract base class for all schema object types.
Field Summary | |
---|---|
protected java.lang.String |
description
a short description of this SchemaObject |
protected boolean |
isObsolete
whether or not this SchemaObject is active |
protected java.lang.String[] |
names
a human readable identifiers for this SchemaObject |
protected java.lang.String |
oid
a numeric object identifier |
protected java.lang.String |
schema
the name of the schema this object is associated with |
Constructor Summary | |
---|---|
protected |
AbstractSchemaObject(java.lang.String oid)
Creates an abstract SchemaObject. |
protected |
AbstractSchemaObject(java.lang.String oid,
boolean isObsolete)
Creates an abstract SchemaObject. |
protected |
AbstractSchemaObject(java.lang.String oid,
java.lang.String description)
Creates an abstract SchemaObject. |
protected |
AbstractSchemaObject(java.lang.String oid,
java.lang.String[] names)
Creates an abstract SchemaObject. |
protected |
AbstractSchemaObject(java.lang.String oid,
java.lang.String[] names,
boolean isObsolete)
Creates an abstract SchemaObject. |
protected |
AbstractSchemaObject(java.lang.String oid,
java.lang.String[] names,
boolean isObsolete,
java.lang.String description)
Creates an abstract SchemaObject. |
protected |
AbstractSchemaObject(java.lang.String oid,
java.lang.String name,
boolean isObsolete)
Creates an abstract SchemaObject. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
If the object implements SchemaObject and has the same OID as this SchemaObject then they are considered equal. |
java.lang.String |
getDescription()
Gets a short description about this SchemaObject. |
java.lang.String |
getName()
Gets the first name in the set of short names for this SchemaObject if any exists for it. |
java.lang.String[] |
getNamesRef()
Gets short names for this SchemaObject if any exists for it. |
java.lang.String |
getOid()
Gets usually what is the numeric object identifier assigned to this SchemaObject. |
java.lang.String |
getSchema()
Gets the name of the schema this SchemaObject is associated with. |
int |
hashCode()
Based on the hashCode of the oid property. |
boolean |
isObsolete()
Gets whether or not this SchemaObject has been inactivated. |
protected void |
setDescription(java.lang.String description)
Sets the brief description for this SchemaObject. |
protected void |
setNames(java.lang.String[] names)
Sets the human readable names for this SchemaObject. |
protected void |
setObsolete(boolean obsolete)
Sets whether or not this SchemaObject is inactived. |
void |
setSchema(java.lang.String schema)
Sets schema name this schema object is associated with. |
java.lang.String |
toString()
Gets the String for the OID of this SchmeaObject. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected final java.lang.String oid
protected boolean isObsolete
protected java.lang.String[] names
protected java.lang.String description
protected java.lang.String schema
Constructor Detail |
---|
protected AbstractSchemaObject(java.lang.String oid)
oid
- the numeric object identifier (OID)
java.lang.NullPointerException
- if oid is nullSchemaObject.getOid()
,
MatchingRuleUse
protected AbstractSchemaObject(java.lang.String oid, java.lang.String[] names)
oid
- the numeric object identifier (OID)names
- the human readable names for this SchemaObject
java.lang.NullPointerException
- if oid is nullprotected AbstractSchemaObject(java.lang.String oid, java.lang.String[] names, boolean isObsolete)
oid
- the numeric object identifier (OID)names
- the human readable names for this SchemaObjectisObsolete
- true if this object is inactive, false if active
java.lang.NullPointerException
- if oid is nullprotected AbstractSchemaObject(java.lang.String oid, java.lang.String name, boolean isObsolete)
oid
- the numeric object identifier (OID)name
- the first human readable name for this SchemaObjectisObsolete
- true if this object is inactive, false if active
java.lang.NullPointerException
- if oid is nullprotected AbstractSchemaObject(java.lang.String oid, boolean isObsolete)
oid
- the numeric object identifier (OID)isObsolete
- true if this object is inactive, false if active
java.lang.NullPointerException
- if oid is nullprotected AbstractSchemaObject(java.lang.String oid, java.lang.String description)
oid
- the numeric object identifier (OID)description
- a brief description for the SchemaObject
java.lang.NullPointerException
- if oid is nullprotected AbstractSchemaObject(java.lang.String oid, java.lang.String[] names, boolean isObsolete, java.lang.String description)
oid
- the numeric object identifier (OID)names
- the human readable names for this SchemaObjectisObsolete
- true if this object is inactive, false if activedescription
- a brief description for the SchemaObject
java.lang.NullPointerException
- if oid is nullMethod Detail |
---|
public java.lang.String getOid()
SchemaObject
getOid
in interface SchemaObject
SchemaObject.getOid()
public boolean isObsolete()
SchemaObject
isObsolete
in interface SchemaObject
SchemaObject.isObsolete()
public java.lang.String[] getNamesRef()
SchemaObject
getNamesRef
in interface SchemaObject
SchemaObject#getNames()
public java.lang.String getSchema()
SchemaObject
getSchema
in interface SchemaObject
SchemaObject.getSchema()
public java.lang.String getName()
SchemaObject
getName
in interface SchemaObject
SchemaObject.getName()
public java.lang.String getDescription()
SchemaObject
getDescription
in interface SchemaObject
SchemaObject.getDescription()
protected void setObsolete(boolean obsolete)
obsolete
- true if this object is inactive, false if it is in usepublic void setSchema(java.lang.String schema)
setSchema
in interface SchemaObject
schema
- the name of the schema this object is associated withprotected void setNames(java.lang.String[] names)
names
- the human readable names for this SchemaObjectprotected void setDescription(java.lang.String description)
description
- the brief description for this SchemaObjectpublic int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- the object to test for equality
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |