org.opennms.netmgt.config.datacollection
Class ResourceType

java.lang.Object
  org.opennms.netmgt.config.datacollection.ResourceType

All Implemented Interfaces:

Serializable

public class ResourceType
extends Object
implements Serializable

a custom resource type

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

ResourceType()

Method Summary

boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getLabel() Returns the value of field 'label'.
String	getName() Returns the value of field 'name'.
PersistenceSelectorStrategy	getPersistenceSelectorStrategy() Returns the value of field 'persistenceSelectorStrategy'.
String	getResourceLabel() Returns the value of field 'resourceLabel'.
StorageStrategy	getStorageStrategy() Returns the value of field 'storageStrategy'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setLabel(String label) Sets the value of field 'label'.
void	setName(String name) Sets the value of field 'name'.
void	setPersistenceSelectorStrategy(PersistenceSelectorStrategy persistenceSelectorStrategy) Sets the value of field 'persistenceSelectorStrategy'.
void	setResourceLabel(String resourceLabel) Sets the value of field 'resourceLabel'.
void	setStorageStrategy(StorageStrategy storageStrategy) Sets the value of field 'storageStrategy'.
static ResourceType	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceType

public ResourceType()

Method Detail

equals

public boolean equals(Object obj)

Overrides the java.lang.Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getLabel

public String getLabel()

Returns the value of field 'label'. The field 'label' has the following description: resource type label (this is what users see in the webUI)

Returns:

the value of field 'Label'.

getName

public String getName()

Returns the value of field 'name'. The field 'name' has the following description: resource type name

Returns:

the value of field 'Name'.

getPersistenceSelectorStrategy

public PersistenceSelectorStrategy getPersistenceSelectorStrategy()

Returns the value of field 'persistenceSelectorStrategy'. The field 'persistenceSelectorStrategy' has the following description: Selects a PersistenceSelectorStrategy that decides which data is persisted and which is not.

Returns:

the value of field 'PersistenceSelectorStrategy'.

getResourceLabel

public String getResourceLabel()

Returns the value of field 'resourceLabel'. The field 'resourceLabel' has the following description: resource label expression (this is what users see in the webUI for each resource of this type)

Returns:

the value of field 'ResourceLabel'.

getStorageStrategy

public StorageStrategy getStorageStrategy()

Returns the value of field 'storageStrategy'. The field 'storageStrategy' has the following description: Selects a StorageStrategy that decides where data is stored.

Returns:

the value of field 'StorageStrategy'.

hashCode

public int hashCode()

Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

setLabel

public void setLabel(String label)

Sets the value of field 'label'. The field 'label' has the following description: resource type label (this is what users see in the webUI)

Parameters:

label - the value of field 'label'.

setName

public void setName(String name)

Sets the value of field 'name'. The field 'name' has the following description: resource type name

Parameters:

name - the value of field 'name'.

setPersistenceSelectorStrategy

public void setPersistenceSelectorStrategy(PersistenceSelectorStrategy persistenceSelectorStrategy)

Sets the value of field 'persistenceSelectorStrategy'. The field 'persistenceSelectorStrategy' has the following description: Selects a PersistenceSelectorStrategy that decides which data is persisted and which is not.

Parameters:

persistenceSelectorStrategy - the value of field 'persistenceSelectorStrategy'.

setResourceLabel

public void setResourceLabel(String resourceLabel)

Sets the value of field 'resourceLabel'. The field 'resourceLabel' has the following description: resource label expression (this is what users see in the webUI for each resource of this type)

Parameters:

resourceLabel - the value of field 'resourceLabel'.

setStorageStrategy

public void setStorageStrategy(StorageStrategy storageStrategy)

Sets the value of field 'storageStrategy'. The field 'storageStrategy' has the following description: Selects a StorageStrategy that decides where data is stored.

Parameters:

storageStrategy - the value of field 'storageStrategy'.

unmarshal

public static ResourceType unmarshal(Reader reader)
                              throws org.exolab.castor.xml.MarshalException,
                                     org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.datacollection.ResourceType

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema