org.opennms.netmgt.jasper.rrdtool
Class Legend

java.lang.Object
  org.opennms.netmgt.jasper.rrdtool.Legend

All Implemented Interfaces:

Serializable

public class Legend
extends Object
implements Serializable

Class Legend.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Legend()

Method Summary

void	addEntry(Entry vEntry)
void	addEntry(int index, Entry vEntry)
Enumeration<Entry>	enumerateEntry() Method enumerateEntry.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Entry[]	getEntry() Method getEntry.Returns the contents of the collection in an Array.
Entry	getEntry(int index) Method getEntry.
List<Entry>	getEntryCollection() Method getEntryCollection.Returns a reference to '_entryList'.
int	getEntryCount() Method getEntryCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Entry>	iterateEntry() Method iterateEntry.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllEntry()
boolean	removeEntry(Entry vEntry) Method removeEntry.
Entry	removeEntryAt(int index) Method removeEntryAt.
void	setEntry(Entry[] vEntryArray)
void	setEntry(int index, Entry vEntry)
void	setEntry(List<Entry> vEntryList) Sets the value of '_entryList' by copying the given Vector.
void	setEntryCollection(List<Entry> entryList) Deprecated.
static Legend	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

Legend

public Legend()

Method Detail

addEntry

public void addEntry(Entry vEntry)
              throws IndexOutOfBoundsException

Parameters:

vEntry -

Throws:

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

addEntry

public void addEntry(int index,
                     Entry vEntry)
              throws IndexOutOfBoundsException

Parameters:

index -

vEntry -

Throws:

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

enumerateEntry

public Enumeration<Entry> enumerateEntry()

Method enumerateEntry.

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.

getEntry

public Entry getEntry(int index)
               throws IndexOutOfBoundsException

Method getEntry.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.jasper.rrdtool.Entry at the given index

Throws:

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

getEntry

public Entry[] getEntry()

Method getEntry.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

getEntryCollection

public List<Entry> getEntryCollection()

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

Returns:

a reference to the Vector backing this class

getEntryCount

public int getEntryCount()

Method getEntryCount.

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

iterateEntry

public Iterator<Entry> iterateEntry()

Method iterateEntry.

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

removeAllEntry

public void removeAllEntry()

removeEntry

public boolean removeEntry(Entry vEntry)

Method removeEntry.

Parameters:

vEntry -

Returns:

true if the object was removed from the collection.

removeEntryAt

public Entry removeEntryAt(int index)

Method removeEntryAt.

Parameters:

index -

Returns:

the element removed from the collection

setEntry

public void setEntry(int index,
                     Entry vEntry)
              throws IndexOutOfBoundsException

Parameters:

index -

vEntry -

Throws:

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

setEntry

public void setEntry(Entry[] vEntryArray)

Parameters:

vEntryArray -

setEntry

public void setEntry(List<Entry> vEntryList)

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

Parameters:

vEntryList - the Vector to copy.

setEntryCollection

public void setEntryCollection(List<Entry> entryList)

Deprecated.

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

Parameters:

entryList - the Vector to set.

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.jasper.rrdtool.Legend

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