Package org.opennms.netmgt.xml.event

Class Maskelement

  • All Implemented Interfaces:
    java.io.Serializable
    public class Maskelement
extends java.lang.Object
implements java.io.Serializable
    The mask element
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      Maskelement()  

    • Method Summary

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

      • addMevalue

        public void addMevalue​(java.lang.String vMevalue)
                throws java.lang.IndexOutOfBoundsException
        Parameters:
        vMevalue -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • addMevalue

        public void addMevalue​(int index,
                       java.lang.String vMevalue)
                throws java.lang.IndexOutOfBoundsException
        Parameters:
        index -
        vMevalue -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • enumerateMevalue

        public java.util.Enumeration<java.lang.String> enumerateMevalue()
        Method enumerateMevalue.
        Returns:
        an Enumeration over all possible elements of this collection

      • getMename

        public java.lang.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 java.lang.String getMevalue​(int index)
                            throws java.lang.IndexOutOfBoundsException
        Method getMevalue.
        Parameters:
        index -
        Returns:
        the value of the java.lang.String at the given index
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • getMevalue

        public java.lang.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 java.util.List<java.lang.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 java.util.Iterator<java.lang.String> iterateMevalue()
        Method iterateMevalue.
        Returns:
        an Iterator over all possible elements in this collection

      • removeAllMevalue

        public void removeAllMevalue()

      • removeMevalue

        public boolean removeMevalue​(java.lang.String vMevalue)
        Method removeMevalue.
        Parameters:
        vMevalue -
        Returns:
        true if the object was removed from the collection.

      • removeMevalueAt

        public java.lang.String removeMevalueAt​(int index)
        Method removeMevalueAt.
        Parameters:
        index -
        Returns:
        the element removed from the collection

      • setMename

        public void setMename​(java.lang.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,
                       java.lang.String vMevalue)
                throws java.lang.IndexOutOfBoundsException
        Parameters:
        index -
        vMevalue -
        Throws:
        java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

      • setMevalue

        public void setMevalue​(java.lang.String[] vMevalueArray)
        Parameters:
        vMevalueArray -

      • setMevalue

        public void setMevalue​(java.util.List<java.lang.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​(java.util.List<java.lang.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 java.lang.String toString()
        Overrides:
        toString in class java.lang.Object