org.opennms.netmgt.config.translator

Class Value

java.lang.Object

org.opennms.netmgt.config.translator.Value

All Implemented Interfaces:

Serializable

public class Value
extends Object
implements Serializable

An element representing a value to be used in a translation.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Value()

Method Summary

Methods

Modifier and Type	Method and Description
void	addValue(int index, Value vValue)
void	addValue(Value vValue)
Enumeration<Value>	enumerateValue() Method enumerateValue.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getMatches() Returns the value of field 'matches'.
String	getName() Returns the value of field 'name'.
String	getResult() Returns the value of field 'result'.
String	getType() Returns the value of field 'type'.
Value[]	getValue() Method getValue.Returns the contents of the collection in an Array.
Value	getValue(int index) Method getValue.
List<Value>	getValueCollection() Method getValueCollection.Returns a reference to '_valueList'.
int	getValueCount() Method getValueCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Value>	iterateValue() Method iterateValue.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllValue()
boolean	removeValue(Value vValue) Method removeValue.
Value	removeValueAt(int index) Method removeValueAt.
void	setMatches(String matches) Sets the value of field 'matches'.
void	setName(String name) Sets the value of field 'name'.
void	setResult(String result) Sets the value of field 'result'.
void	setType(String type) Sets the value of field 'type'.
void	setValue(int index, Value vValue)
void	setValue(List<Value> vValueList) Sets the value of '_valueList' by copying the given Vector.
void	setValue(Value[] vValueArray)
void	setValueCollection(List<Value> valueList) Deprecated.
static Value	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

Value

public Value()

Method Detail

addValue

public void addValue(Value vValue)
              throws IndexOutOfBoundsException

Parameters:

vValue -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addValue

public void addValue(int index,
            Value vValue)
              throws IndexOutOfBoundsException

Parameters:

index -

vValue -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateValue

public Enumeration<Value> enumerateValue()

Method enumerateValue.

Returns:

an Enumeration over all possible elements of this collection

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.

getMatches

public String getMatches()

Returns the value of field 'matches'.

Returns:

the value of field 'Matches'.

getName

public String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

getResult

public String getResult()

Returns the value of field 'result'.

Returns:

the value of field 'Result'.

getType

public String getType()

Returns the value of field 'type'.

Returns:

the value of field 'Type'.

getValue

public Value getValue(int index)
               throws IndexOutOfBoundsException

Method getValue.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.translator.Value at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getValue

public Value[] getValue()

Method getValue.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getValueCollection

public List<Value> getValueCollection()

Method getValueCollection.Returns a reference to '_valueList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getValueCount

public int getValueCount()

Method getValueCount.

Returns:

the size of this collection

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

iterateValue

public Iterator<Value> iterateValue()

Method iterateValue.

Returns:

an Iterator over all possible elements in this collection

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

removeAllValue

public void removeAllValue()

removeValue

public boolean removeValue(Value vValue)

Method removeValue.

Parameters:

vValue -

Returns:

true if the object was removed from the collection.

removeValueAt

public Value removeValueAt(int index)

Method removeValueAt.

Parameters:

index -

Returns:

the element removed from the collection

setMatches

public void setMatches(String matches)

Sets the value of field 'matches'.

Parameters:

matches - the value of field 'matches'.

setName

public void setName(String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setResult

public void setResult(String result)

Sets the value of field 'result'.

Parameters:

result - the value of field 'result'.

setType

public void setType(String type)

Sets the value of field 'type'.

Parameters:

type - the value of field 'type'.

setValue

public void setValue(int index,
            Value vValue)
              throws IndexOutOfBoundsException

Parameters:

index -

vValue -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setValue

public void setValue(Value[] vValueArray)

Parameters:

vValueArray -

setValue

public void setValue(List<Value> vValueList)

Sets the value of '_valueList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vValueList - the Vector to copy.

setValueCollection

public void setValueCollection(List<Value> valueList)

Deprecated.

Sets the value of '_valueList' by setting it to the given Vector. No type checking is performed.

Parameters:

valueList - the Vector to set.

unmarshal

public static Value 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.translator.Value

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