org.apache.directory.shared.converter.schema
Class ObjectClassHolder

java.lang.Object
  org.apache.directory.shared.converter.schema.SchemaElementImpl
      org.apache.directory.shared.converter.schema.ObjectClassHolder

All Implemented Interfaces:

SchemaElement

public class ObjectClassHolder
extends SchemaElementImpl

A bean used to encapsulate the literal String values of an ObjectClass definition found within an OpenLDAP schema configuration file.

Version:

$Rev: 437016 $

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.converter.schema.SchemaElementImpl

description, extensions, names, obsolete, oid

Constructor Summary

ObjectClassHolder(java.lang.String oid)
Create an instance of ObjectClass element

Method Summary

java.lang.String	dnToLdif(java.lang.String schemaName)
ObjectClassTypeEnum	getClassType()
java.util.List<java.lang.String>	getMay()
java.util.List<java.lang.String>	getMust()
java.util.List<java.lang.String>	getSuperiors() Get the list of superior for this objectClass
void	setClassType(ObjectClassTypeEnum classType) Set the objectClass type.
void	setMay(java.util.List<java.lang.String> may) Set the list of optional attributes
void	setMust(java.util.List<java.lang.String> must) Set the list of mandatory attributes
void	setSuperiors(java.util.List<java.lang.String> superiors) Set the list of inherited objectClasses
java.lang.String	toLdif(java.lang.String schemaName) Convert this objectClass to a Ldif string
java.lang.String	toString() Return a String representing this ObjectClass.

Methods inherited from class org.apache.directory.shared.converter.schema.SchemaElementImpl

extensionsToLdif, getDescription, getExtensions, getNames, getOid, isObsolete, schemaToLdif, setDescription, setExtensions, setNames, setObsolete

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ObjectClassHolder

public ObjectClassHolder(java.lang.String oid)

Create an instance of ObjectClass element

Method Detail

getSuperiors

public java.util.List<java.lang.String> getSuperiors()

Get the list of superior for this objectClass

Returns:

A list of all inherited objectClasses

setSuperiors

public void setSuperiors(java.util.List<java.lang.String> superiors)

Set the list of inherited objectClasses

Parameters:

superiors - The list of inherited objectClasses

getMust

public java.util.List<java.lang.String> getMust()

Returns:

The list of mandatory attributes

setMust

public void setMust(java.util.List<java.lang.String> must)

Set the list of mandatory attributes

Parameters:

must - The list of mandatory attributes

getMay

public java.util.List<java.lang.String> getMay()

Returns:

The list of optional attributes

setMay

public void setMay(java.util.List<java.lang.String> may)

Set the list of optional attributes

Parameters:

may - The list of optional attributes

getClassType

public ObjectClassTypeEnum getClassType()

Returns:

The objectClass type

setClassType

public void setClassType(ObjectClassTypeEnum classType)

Set the objectClass type.

Parameters:

classType - The objectClass type.

toLdif

public java.lang.String toLdif(java.lang.String schemaName)
                        throws javax.naming.NamingException

Convert this objectClass to a Ldif string

Parameters:

schemaName - The name of the schema file containing this objectClass

Returns:

A ldif formatted string

Throws:

javax.naming.NamingException - If any error occurs.

toString

public java.lang.String toString()

Return a String representing this ObjectClass.

Overrides:

toString in class java.lang.Object

dnToLdif

public java.lang.String dnToLdif(java.lang.String schemaName)
                          throws javax.naming.NamingException

Specified by:

dnToLdif in class SchemaElementImpl

Returns:

The dn as a ldif line

Throws:

javax.naming.NamingException