org.opennms.netmgt.config.surveillanceViews

Class Views

java.lang.Object

org.opennms.netmgt.config.surveillanceViews.Views

All Implemented Interfaces:

Serializable

public class Views
extends Object
implements Serializable

Class Views.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Views()

Method Summary

Modifier and Type	Method and Description
void	addView(int index, View vView)
void	addView(View vView)
Enumeration<View>	enumerateView() Method enumerateView.
boolean	equals(Object obj) Overrides the Object.equals method.
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.
int	hashCode() Method hashCode.
Iterator<View>	iterateView() Method iterateView.
void	removeAllView()
boolean	removeView(View vView) Method removeView.
View	removeViewAt(int index) Method removeViewAt.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Views

public Views()

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

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 Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getView

public View getView(int index)
             throws IndexOutOfBoundsException

Method getView.

Parameters:

index -

Returns:

the value of the View at the given index

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

hashCode

public int hashCode()

Method hashCode.

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

iterateView

public Iterator<View> iterateView()

Method iterateView.

Returns:

an Iterator over all possible elements in this collection

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

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.