raccoon.core.types
Class ConfigurableProperty

java.lang.Object
  extended by raccoon.core.types.ConfigurableProperty

public class ConfigurableProperty
extends java.lang.Object

A descriptor for a changable property.

Since:
Raccoon v0.8
Version:
$Id: ConfigurableProperty.java,v 1.1 2004/08/08 20:19:18 crouvrais Exp $
Author:
Cedric ROUVRAIS

Constructor Summary
ConfigurableProperty()
           
 
Method Summary
 java.lang.Class getElement()
          The element type of a collection property
 java.lang.Class getInterface()
          The interface that this property is supposed to implement.
 java.lang.String getName()
          Assigns the name of this property instance.
 boolean isRequired()
          Is this property required
 boolean isSet()
          Has the value of the property been set.
 void setElement(java.lang.Class pElement)
          Assigns the element type if this is a collection property
 void setInterface(java.lang.Class pInterface)
          Defines the interface that this property should implement.
 void setName(java.lang.String pName)
          The name of the property used as a key in the hashmap.
 void setRequired(boolean pRequired)
          Defines whether this property is required or not.
 void setSet(boolean pSet)
          Set the state of the definition of this property.
 java.lang.String toString()
          Generates the string representation of this object
 java.lang.String toXmlString(java.lang.String pIndent)
          Generates the string representation for Raccoon Service Manager.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ConfigurableProperty

public ConfigurableProperty()
Method Detail

getName

public java.lang.String getName()
Assigns the name of this property instance.

Returns:
the name of the property

setName

public void setName(java.lang.String pName)
The name of the property used as a key in the hashmap.

Parameters:
pName - the name of the property, first letter should be upper case.

getInterface

public java.lang.Class getInterface()
The interface that this property is supposed to implement.

Returns:
the interface

setInterface

public void setInterface(java.lang.Class pInterface)
Defines the interface that this property should implement.

Parameters:
pInterface - the interface.

isSet

public boolean isSet()
Has the value of the property been set.

Returns:
true if this required property has been set.

setSet

public void setSet(boolean pSet)
Set the state of the definition of this property.

Parameters:
pSet - the value, true if this property has been defined.

isRequired

public boolean isRequired()
Is this property required

Returns:
true if this property must be set before invoking load

setRequired

public void setRequired(boolean pRequired)
Defines whether this property is required or not.

Parameters:
pRequired - true if this property must be set before loading.

getElement

public java.lang.Class getElement()
The element type of a collection property

Returns:
the element that this collection property contains.

setElement

public void setElement(java.lang.Class pElement)
Assigns the element type if this is a collection property

Parameters:
pElement - the element type.

toString

public java.lang.String toString()
Generates the string representation of this object

Overrides:
toString in class java.lang.Object
Returns:
the string representation of this object.

toXmlString

public java.lang.String toXmlString(java.lang.String pIndent)
Generates the string representation for Raccoon Service Manager. TODO Improve the source code of this method.

Parameters:
pIndent - the current level of indentation.
Returns:
the string representation of this object.


Copyright null null. All Rights Reserved.