org.openbp.common.generic.propertybrowser
Class CollectionDescriptor

java.lang.Object
  org.openbp.common.generic.propertybrowser.CollectionDescriptor

All Implemented Interfaces:

java.lang.Cloneable, Copyable

public class CollectionDescriptor
extends java.lang.Object
implements java.lang.Cloneable, Copyable

The collection descriptor defines the type and settings of a collection property.

Author:

Heiko Erhardt

Field Summary

Fields inherited from interface org.openbp.common.generic.Copyable

COPY_DEEP, COPY_FIRST_LEVEL, COPY_SHALLOW

Constructor Summary

CollectionDescriptor()
Default constructor.

Method Summary

java.lang.Object	clone() Creates a clone of this object.
void	copyFrom(java.lang.Object source, int copyMode) Copies the values of the source object to this object.
java.lang.Class	getSafeTypeClass() Gets the type class, instantiating it if possible.
java.lang.Class	getTypeClass() Gets the type class.
java.lang.String	getTypeClassName() Gets the type class name.
boolean	hasAddEnabled() Determines if the add enabled is set.
boolean	hasDeleteEnabled() Determines if the delete enabled is set.
boolean	hasReorderEnabled() Determines if the reorder enabled is set.
boolean	isAddEnabled() Gets the add enabled.
boolean	isDeleteEnabled() Gets the delete enabled.
boolean	isReorderEnabled() Gets the reorder enabled.
void	setAddEnabled(boolean addEnabled) Sets the add enabled.
void	setDeleteEnabled(boolean deleteEnabled) Sets the delete enabled.
void	setReorderEnabled(boolean reorderEnabled) Sets the reorder enabled.
void	setTypeClass(java.lang.Class typeClass) Sets the type class.
void	setTypeClassName(java.lang.String typeClassName) Sets the type class name.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionDescriptor

public CollectionDescriptor()

Default constructor.

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Creates a clone of this object.

Specified by:

clone in interface Copyable

Overrides:

clone in class java.lang.Object

Returns:

The clone (a deep copy of this object)

Throws:

java.lang.CloneNotSupportedException - If the cloning of one of the contained members failed

copyFrom

public void copyFrom(java.lang.Object source,
                     int copyMode)
              throws java.lang.CloneNotSupportedException

Copies the values of the source object to this object.

Specified by:

copyFrom in interface Copyable

Parameters:

source - The source object. Must be of the same type as this object.

copyMode - Determines if a deep copy, a first level copy or a shallow copy is to be performed. See the constants of the org.openbp.common.generic.description.Copyable class.

Throws:

java.lang.CloneNotSupportedException - If the cloning of one of the contained objects failed

getTypeClassName

public java.lang.String getTypeClassName()

Gets the type class name.

setTypeClassName

public void setTypeClassName(java.lang.String typeClassName)

Sets the type class name.

isAddEnabled

public boolean isAddEnabled()

Gets the add enabled.

hasAddEnabled

public boolean hasAddEnabled()

Determines if the add enabled is set. Will be removed if Castor supports boolean defaults.

setAddEnabled

public void setAddEnabled(boolean addEnabled)

Sets the add enabled.

isDeleteEnabled

public boolean isDeleteEnabled()

Gets the delete enabled.

hasDeleteEnabled

public boolean hasDeleteEnabled()

Determines if the delete enabled is set. Will be removed if Castor supports boolean defaults.

setDeleteEnabled

public void setDeleteEnabled(boolean deleteEnabled)

Sets the delete enabled.

isReorderEnabled

public boolean isReorderEnabled()

Gets the reorder enabled.

hasReorderEnabled

public boolean hasReorderEnabled()

Determines if the reorder enabled is set. Will be removed if Castor supports boolean defaults.

setReorderEnabled

public void setReorderEnabled(boolean reorderEnabled)

Sets the reorder enabled.

getSafeTypeClass

public java.lang.Class getSafeTypeClass()

Gets the type class, instantiating it if possible.

getTypeClass

public java.lang.Class getTypeClass()

Gets the type class.

setTypeClass

public void setTypeClass(java.lang.Class typeClass)

Sets the type class.