org.pentaho.reporting.tools.configeditor.model

Class ClassConfigDescriptionEntry

java.lang.Object

org.pentaho.reporting.tools.configeditor.model.ConfigDescriptionEntry

org.pentaho.reporting.tools.configeditor.model.ClassConfigDescriptionEntry

public class ClassConfigDescriptionEntry
extends ConfigDescriptionEntry

A config description entry that describes class name configurations. The specified class in the configuration is forced to be a subclass of the specified base class.

Author:

Thomas Morgner

Constructor Summary

Constructors

Constructor and Description
ClassConfigDescriptionEntry(String keyName) Creates a new config description entry.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Checks whether the given object is equal to this config description entry.
Class	getBaseClass() Returns the base class used to verify the configuration values.
int	hashCode() Computes an hashcode for this object.
void	setBaseClass(Class baseClass) Defines the base class for this configuration entry.

Methods inherited from class org.pentaho.reporting.tools.configeditor.model.ConfigDescriptionEntry

getDescription, getKeyName, isGlobal, isHidden, setDescription, setGlobal, setHidden

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClassConfigDescriptionEntry

public ClassConfigDescriptionEntry(String keyName)

Creates a new config description entry.

Parameters:

keyName - the full name of the key.

Method Detail

getBaseClass

public Class getBaseClass()

Returns the base class used to verify the configuration values.

Returns:

the base class or Object.class if not specified otherwise.

setBaseClass

public void setBaseClass(Class baseClass)

Defines the base class for this configuration entry.

Parameters:

baseClass - the base class, never null.

equals

public boolean equals(Object o)

Description copied from class: ConfigDescriptionEntry

Checks whether the given object is equal to this config description entry. The object will be equal, if it is also an config description entry with the same name as this entry.

Overrides:

equals in class ConfigDescriptionEntry

Parameters:

o - the other object.

Returns:

true, if the config entry is equal to the given object, false otherwise.

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Description copied from class: ConfigDescriptionEntry

Computes an hashcode for this object.

Overrides:

hashCode in class ConfigDescriptionEntry

Returns:

the hashcode.

See Also:

Object.hashCode()