org.opennms.netmgt.config.viewsdisplay

Class Viewinfo

java.lang.Object

org.opennms.netmgt.config.viewsdisplay.Viewinfo

All Implemented Interfaces:

Serializable

public class Viewinfo
extends Object
implements Serializable

Top-level element for the viewsdisplay.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Viewinfo()

Method Summary

Methods

Modifier and Type	Method and Description
void	addView(int index, View vView)
void	addView(View vView)
void	deleteDisconnectTimeout()
Enumeration<View>	enumerateView() Method enumerateView.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getDefaultView() Returns the value of field 'defaultView'.
int	getDisconnectTimeout() Returns the value of field 'disconnectTimeout'.
View[]	getView() Method getView.Returns the contents of the collection in an Array.
View	getView(int index) Method getView.
List<View>	getViewCollection() Method getViewCollection.Returns a reference to '_viewList'.
int	getViewCount() Method getViewCount.
boolean	hasDisconnectTimeout() Method hasDisconnectTimeout.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<View>	iterateView() Method iterateView.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllView()
boolean	removeView(View vView) Method removeView.
View	removeViewAt(int index) Method removeViewAt.
void	setDefaultView(String defaultView) Sets the value of field 'defaultView'.
void	setDisconnectTimeout(int disconnectTimeout) Sets the value of field 'disconnectTimeout'.
void	setView(int index, View vView)
void	setView(List<View> vViewList) Sets the value of '_viewList' by copying the given Vector.
void	setView(View[] vViewArray)
void	setViewCollection(List<View> viewList) Deprecated.
static Viewinfo	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

Viewinfo

public Viewinfo()

Method Detail

addView

public void addView(View vView)
             throws IndexOutOfBoundsException

Parameters:

vView -

Throws:

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

addView

public void addView(int index,
           View vView)
             throws IndexOutOfBoundsException

Parameters:

index -

vView -

Throws:

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

deleteDisconnectTimeout

public void deleteDisconnectTimeout()

enumerateView

public Enumeration<View> enumerateView()

Method enumerateView.

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.

getDefaultView

public String getDefaultView()

Returns the value of field 'defaultView'.

Returns:

the value of field 'DefaultView'.

getDisconnectTimeout

public int getDisconnectTimeout()

Returns the value of field 'disconnectTimeout'.

Returns:

the value of field 'DisconnectTimeout'.

getView

public View getView(int index)
             throws IndexOutOfBoundsException

Method getView.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.viewsdisplay.View at the given inde

Throws:

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

getView

public View[] getView()

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

getViewCollection

public List<View> getViewCollection()

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

Returns:

a reference to the Vector backing this class

getViewCount

public int getViewCount()

Method getViewCount.

Returns:

the size of this collection

hasDisconnectTimeout

public boolean hasDisconnectTimeout()

Method hasDisconnectTimeout.

Returns:

true if at least one DisconnectTimeout has been added

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

iterateView

public Iterator<View> iterateView()

Method iterateView.

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

removeAllView

public void removeAllView()

removeView

public boolean removeView(View vView)

Method removeView.

Parameters:

vView -

Returns:

true if the object was removed from the collection.

removeViewAt

public View removeViewAt(int index)

Method removeViewAt.

Parameters:

index -

Returns:

the element removed from the collection

setDefaultView

public void setDefaultView(String defaultView)

Sets the value of field 'defaultView'.

Parameters:

defaultView - the value of field 'defaultView'.

setDisconnectTimeout

public void setDisconnectTimeout(int disconnectTimeout)

Sets the value of field 'disconnectTimeout'.

Parameters:

disconnectTimeout - the value of field 'disconnectTimeout'.

setView

public void setView(int index,
           View vView)
             throws IndexOutOfBoundsException

Parameters:

index -

vView -

Throws:

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

setView

public void setView(View[] vViewArray)

Parameters:

vViewArray -

setView

public void setView(List<View> vViewList)

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

Parameters:

vViewList - the Vector to copy.

setViewCollection

public void setViewCollection(List<View> viewList)

Deprecated.

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

Parameters:

viewList - the Vector to set.

unmarshal

public static Viewinfo 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.viewsdisplay.Viewinfo

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