com.novell.application.console.snapin

Class ObjectType

java.lang.Object

com.novell.application.console.snapin.ObjectType

All Implemented Interfaces:

java.io.Serializable

public class ObjectType
extends java.lang.Object
implements java.io.Serializable

Provides the base class for object types supported by a namespace.

An ObjectType is a lightweight representation of a class of objects defined by a namespace. This class is made final so that it cannot be subclassed.

See Also:

ObjectEntry, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_container
protected boolean	m_filesystem
protected boolean	m_isHidden
protected boolean	m_isNull
protected ObjectType[]	m_parentType
protected boolean	m_shortcut

Constructor Summary

Constructors

Constructor and Description
ObjectType(NamespaceSnapin space, boolean container, ObjectType[] parentTypes)
ObjectType(java.lang.String name, NamespaceSnapin space, boolean container) Constructs an ObjectType for the specified namespace without the parentTypes parameter (set to null).
ObjectType(java.lang.String name, NamespaceSnapin space, boolean container, ObjectType parentType) Constructs an ObjectType for the specified namespace with the parent the ObjectType.
ObjectType(java.lang.String name, NamespaceSnapin space, boolean container, ObjectType[] parentTypes) Constructs an ObjectType for the specified namespace with an array of parentTypes.
ObjectType(java.lang.String name, NamespaceSnapin space, boolean container, ObjectType[] parentTypes, boolean shortcut) Constructs an ObjectType for the specified namespace with an array of parentTypes.
ObjectType(java.lang.String name, NamespaceSnapin space, boolean container, ObjectType parentType, boolean shortcut) Constructs an ObjectType for the specified namespace with the parent the ObjectType.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Compares this ObjectType to the ObjectType passed in and returns true if their names and Namespace unique IDs are the same.
AdminNamespace	getAdminNamespace() Returns the namespace object in which this ObjectType resides.
java.lang.String	getKey()
java.lang.String	getName() Returns the name of the ObjectType as a String.
NamespaceSnapin	getNamespace() Returns the namespace object in which this ObjectType resides.
ObjectType[]	getParentTypes() Returns the parent in an OjectType array.
int	hashCode() Returns the hash code for this ObjectType for use in hash tables.
boolean	isContainer() Checks to see if the ObjectType is a container.
boolean	isFileSystem() Checks to see if the ObjectType is a File System type.
boolean	isHidden()
boolean	isNull()
boolean	isShortcut()
void	setHidden(boolean hide)
void	setIsFileSystem(boolean isFileSystem) Sets this ObjectType to be a File System type.
java.lang.String	toString() Create a string representation of the ObjectType.

Methods inherited from class java.lang.Object

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

Field Detail

m_container

protected boolean m_container

m_parentType

protected ObjectType[] m_parentType

m_filesystem

protected boolean m_filesystem

m_shortcut

protected boolean m_shortcut

m_isNull

protected boolean m_isNull

m_isHidden

protected boolean m_isHidden

Constructor Detail

ObjectType

public ObjectType(java.lang.String name,
                  NamespaceSnapin space,
                  boolean container,
                  ObjectType parentType)

Constructs an ObjectType for the specified namespace with the parent the ObjectType.

Parameters:

name - The name of the ObjectType.

space - The namespace to which the ObjectType belongs.

container - A boolean flag set to true if the ObjectType can contain other objects, otherwise set to false.

parentType - The parent of this ObjectType.

ObjectType

public ObjectType(java.lang.String name,
                  NamespaceSnapin space,
                  boolean container,
                  ObjectType[] parentTypes)

Constructs an ObjectType for the specified namespace with an array of parentTypes.

Parameters:

name - The name of the ObjectType.

space - The namespace to which the ObjectType belongs.

container - A boolean flag set to true if the ObjectType can contain other objects, otherwise set to false.

parentTypes - The array of parentTypes for this ObjectType.

ObjectType

public ObjectType(java.lang.String name,
                  NamespaceSnapin space,
                  boolean container)

Constructs an ObjectType for the specified namespace without the parentTypes parameter (set to null).

Parameters:

name - The name of the ObjectType.

space - The namespace to which the ObjectType belongs.

container - A boolean flag set to true if the ObjectType can contain other objects, otherwise set to false.

ObjectType

public ObjectType(NamespaceSnapin space,
                  boolean container,
                  ObjectType[] parentTypes)

Parameters:

space - The namespace to which the ObjectType belongs.

container - A boolean flag set to true if the ObjectType can contain other objects, otherwise set to false.

parentTypes - The array of parentTypes for this ObjectType.

ObjectType

public ObjectType(java.lang.String name,
                  NamespaceSnapin space,
                  boolean container,
                  ObjectType parentType,
                  boolean shortcut)

Constructs an ObjectType for the specified namespace with the parent the ObjectType.

Parameters:

name - The name of the ObjectType.

space - The namespace to which the ObjectType belongs.

container - A boolean flag set to true if the ObjectType can contain other objects, otherwise set to false.

parentType - The parent of this ObjectType.

shortcut - A boolean flag set to true if the ObjectType is to be used as the type for shortcut entries.

ObjectType

public ObjectType(java.lang.String name,
                  NamespaceSnapin space,
                  boolean container,
                  ObjectType[] parentTypes,
                  boolean shortcut)

Constructs an ObjectType for the specified namespace with an array of parentTypes.

Parameters:

name - The name of the ObjectType.

space - The namespace to which the ObjectType belongs.

container - A boolean flag set to true if the ObjectType can contain other objects, otherwise set to false.

parentTypes - The array of parentTypes for this ObjectType.

shortcut - A boolean flag set to true if the ObjectType is to be used as the type for shortcut entries.

Method Detail

getParentTypes

public ObjectType[] getParentTypes()

Returns the parent in an OjectType array.

If there is no parent to be returned in the ObjectType array, null can be returned.

Returns:

The ObjectType array containing the parent, or null if there is no parent.

isShortcut

public boolean isShortcut()

getName

public final java.lang.String getName()

Returns the name of the ObjectType as a String.

Returns:

The name of the ObjectType.

isContainer

public boolean isContainer()

Checks to see if the ObjectType is a container.

Returns:

A boolean set to true if the ObjectType is a container, otherwise set to false.

isFileSystem

public boolean isFileSystem()

Checks to see if the ObjectType is a File System type. this could be a Filesystem Volume, Directory, or File

Returns:

A boolean set to true if the ObjectType is a container, otherwise set to false.

setIsFileSystem

public void setIsFileSystem(boolean isFileSystem)

Sets this ObjectType to be a File System type. this could be for Filesystem Volume, Directory, or File This option is not exposed through a constructor so must be set through this call

Parameters:

isFileSystem - - A boolean set to true if the ObjectType is a File System type, otherwise set to false.

getAdminNamespace

public final AdminNamespace getAdminNamespace()

Returns the namespace object in which this ObjectType resides.

Returns:

The AdminNamespace object in which this ObjectType resides.

getNamespace

public final NamespaceSnapin getNamespace()

Returns the namespace object in which this ObjectType resides. For backward compatibility, the method returns a NamespaceSnapin object. The caller can cast this to an AdminNamespace, or if protocol-specific operations are to be done, then cast it to an NDSNamespace or LDAPNamespace object.

Returns:

The NamespaceSnapin object in which this ObjectType resides.

equals

public boolean equals(java.lang.Object object)

Compares this ObjectType to the ObjectType passed in and returns true if their names and Namespace unique IDs are the same.

This is preferred over == for comparing ObjectTypes since there may be two different instances of the same logical ObjectType.

Overrides:

equals in class java.lang.Object

Parameters:

object - ObjectType passed in to be used in the comparison.

Returns:

If the ObjectTypes are equal, true is returned, otherwise false is returned.

hashCode

public int hashCode()

Returns the hash code for this ObjectType for use in hash tables. Two ObjectTypes that compare to true using the equals method will return the same hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code for this ObjecType.

getKey

public final java.lang.String getKey()

isNull

public boolean isNull()

setHidden

public void setHidden(boolean hide)

isHidden

public boolean isHidden()

toString

public java.lang.String toString()

Create a string representation of the ObjectType.

Overrides:

toString in class java.lang.Object

Returns:

A string representing the ObjectType