org.opennms.netmgt.xml.event

Class Maskelement

java.lang.Object

org.opennms.netmgt.xml.event.Maskelement

All Implemented Interfaces:

Serializable

public class Maskelement
extends Object
implements Serializable

The mask element

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Maskelement()

Method Summary

Modifier and Type	Method and Description
void	addMevalue(int index, String vMevalue)
void	addMevalue(String vMevalue)
static Maskelement	copyFrom(IMaskElement copy)
Enumeration<String>	enumerateMevalue() Method enumerateMevalue.
String	getMename() Returns the value of field 'mename'.
String[]	getMevalue() Method getMevalue.Returns the contents of the collection in an Array.
String	getMevalue(int index) Method getMevalue.
List<String>	getMevalueCollection() Method getMevalueCollection.Returns a reference to '_mevalueList'.
int	getMevalueCount() Method getMevalueCount.
Iterator<String>	iterateMevalue() Method iterateMevalue.
void	removeAllMevalue()
boolean	removeMevalue(String vMevalue) Method removeMevalue.
String	removeMevalueAt(int index) Method removeMevalueAt.
void	setMename(String mename) Sets the value of field 'mename'.
void	setMevalue(int index, String vMevalue)
void	setMevalue(List<String> vMevalueList) Sets the value of '_mevalueList' by copying the given Vector.
void	setMevalue(String[] vMevalueArray)
void	setMevalueCollection(List<String> mevalueList) Deprecated.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Maskelement

public Maskelement()

Method Detail

copyFrom

public static Maskelement copyFrom(IMaskElement copy)

addMevalue

public void addMevalue(String vMevalue)
                throws IndexOutOfBoundsException

Parameters:

vMevalue -

Throws:

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

addMevalue

public void addMevalue(int index,
                       String vMevalue)
                throws IndexOutOfBoundsException

Parameters:

index -

vMevalue -

Throws:

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

enumerateMevalue

public Enumeration<String> enumerateMevalue()

Method enumerateMevalue.

Returns:

an Enumeration over all possible elements of this collection

getMename

public String getMename()

Returns the value of field 'mename'. The field 'mename' has the following description: The mask element name can only be one of those specified above

Returns:

the value of field 'Mename'.

getMevalue

public String getMevalue(int index)
                  throws IndexOutOfBoundsException

Method getMevalue.

Parameters:

index -

Returns:

the value of the java.lang.String at the given index

Throws:

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

getMevalue

public String[] getMevalue()

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

getMevalueCollection

public List<String> getMevalueCollection()

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

Returns:

a reference to the Vector backing this class

getMevalueCount

public int getMevalueCount()

Method getMevalueCount.

Returns:

the size of this collection

iterateMevalue

public Iterator<String> iterateMevalue()

Method iterateMevalue.

Returns:

an Iterator over all possible elements in this collection

removeAllMevalue

public void removeAllMevalue()

removeMevalue

public boolean removeMevalue(String vMevalue)

Method removeMevalue.

Parameters:

vMevalue -

Returns:

true if the object was removed from the collection.

removeMevalueAt

public String removeMevalueAt(int index)

Method removeMevalueAt.

Parameters:

index -

Returns:

the element removed from the collection

setMename

public void setMename(String mename)

Sets the value of field 'mename'. The field 'mename' has the following description: The mask element name can only be one of those specified above

Parameters:

mename - the value of field 'mename'.

setMevalue

public void setMevalue(int index,
                       String vMevalue)
                throws IndexOutOfBoundsException

Parameters:

index -

vMevalue -

Throws:

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

setMevalue

public void setMevalue(String[] vMevalueArray)

Parameters:

vMevalueArray -

setMevalue

public void setMevalue(List<String> vMevalueList)

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

Parameters:

vMevalueList - the Vector to copy.

setMevalueCollection

public void setMevalueCollection(List<String> mevalueList)

Deprecated.

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

Parameters:

mevalueList - the Vector to set.

toString

public String toString()

Overrides:

toString in class Object