UeiMatch (OpenNMS 14.0.2-SNAPSHOT API)

java.lang.Object
- org.opennms.netmgt.config.syslogd.UeiMatch

All Implemented Interfaces:

Serializable
```
public class UeiMatch
extends Object
implements Serializable
```
List of Strings to UEI matches

Version:

$Revision$ $Date$

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

UeiMatch()

Constructors
Constructor and Description
`UeiMatch()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addFacility(int index, String vFacility)`
`void`	`addFacility(String vFacility)`
`void`	`addParameterAssignment(int index, ParameterAssignment vParameterAssignment)`
`void`	`addParameterAssignment(ParameterAssignment vParameterAssignment)`
`void`	`addSeverity(int index, String vSeverity)`
`void`	`addSeverity(String vSeverity)`
`Enumeration<String>`	`enumerateFacility()` Method enumerateFacility.
`Enumeration<ParameterAssignment>`	`enumerateParameterAssignment()` Method enumerateParameterAssignment.
`Enumeration<String>`	`enumerateSeverity()` Method enumerateSeverity.
`boolean`	`equals(Object obj)` Overrides the java.lang.Object.equals method.
`String[]`	`getFacility()` Method getFacility.Returns the contents of the collection in an Array.
`String`	`getFacility(int index)` Method getFacility.
`List<String>`	`getFacilityCollection()` Method getFacilityCollection.Returns a reference to '_facilityList'.
`int`	`getFacilityCount()` Method getFacilityCount.
`HostaddrMatch`	`getHostaddrMatch()` Returns the value of field 'hostaddrMatch'.
`HostnameMatch`	`getHostnameMatch()` Returns the value of field 'hostnameMatch'.
`Match`	`getMatch()` Returns the value of field 'match'.
`ParameterAssignment[]`	`getParameterAssignment()` Method getParameterAssignment.Returns the contents of the collection in an Array.
`ParameterAssignment`	`getParameterAssignment(int index)` Method getParameterAssignment.
`List<ParameterAssignment>`	`getParameterAssignmentCollection()` Method getParameterAssignmentCollection.Returns a reference to '_parameterAssignmentList'.
`int`	`getParameterAssignmentCount()` Method getParameterAssignmentCount.
`ProcessMatch`	`getProcessMatch()` Returns the value of field 'processMatch'.
`String[]`	`getSeverity()` Method getSeverity.Returns the contents of the collection in an Array.
`String`	`getSeverity(int index)` Method getSeverity.
`List<String>`	`getSeverityCollection()` Method getSeverityCollection.Returns a reference to '_severityList'.
`int`	`getSeverityCount()` Method getSeverityCount.
`String`	`getUei()` Returns the value of field 'uei'.
`int`	`hashCode()` Overrides the java.lang.Object.hashCode method.
`boolean`	`isValid()` Method isValid.
`Iterator<String>`	`iterateFacility()` Method iterateFacility.
`Iterator<ParameterAssignment>`	`iterateParameterAssignment()` Method iterateParameterAssignment.
`Iterator<String>`	`iterateSeverity()` Method iterateSeverity.
`void`	`marshal(ContentHandler handler)`
`void`	`marshal(Writer out)`
`void`	`removeAllFacility()`
`void`	`removeAllParameterAssignment()`
`void`	`removeAllSeverity()`
`boolean`	`removeFacility(String vFacility)` Method removeFacility.
`String`	`removeFacilityAt(int index)` Method removeFacilityAt.
`boolean`	`removeParameterAssignment(ParameterAssignment vParameterAssignment)` Method removeParameterAssignment.
`ParameterAssignment`	`removeParameterAssignmentAt(int index)` Method removeParameterAssignmentAt.
`boolean`	`removeSeverity(String vSeverity)` Method removeSeverity.
`String`	`removeSeverityAt(int index)` Method removeSeverityAt.
`void`	`setFacility(int index, String vFacility)`
`void`	`setFacility(List<String> vFacilityList)` Sets the value of '_facilityList' by copying the given Vector.
`void`	`setFacility(String[] vFacilityArray)`
`void`	`setFacilityCollection(List<String> facilityList)` Deprecated.
`void`	`setHostaddrMatch(HostaddrMatch hostaddrMatch)` Sets the value of field 'hostaddrMatch'.
`void`	`setHostnameMatch(HostnameMatch hostnameMatch)` Sets the value of field 'hostnameMatch'.
`void`	`setMatch(Match match)` Sets the value of field 'match'.
`void`	`setParameterAssignment(int index, ParameterAssignment vParameterAssignment)`
`void`	`setParameterAssignment(List<ParameterAssignment> vParameterAssignmentList)` Sets the value of '_parameterAssignmentList' by copying the given Vector.
`void`	`setParameterAssignment(ParameterAssignment[] vParameterAssignmentArray)`
`void`	`setParameterAssignmentCollection(List<ParameterAssignment> parameterAssignmentList)` Deprecated.
`void`	`setProcessMatch(ProcessMatch processMatch)` Sets the value of field 'processMatch'.
`void`	`setSeverity(int index, String vSeverity)`
`void`	`setSeverity(List<String> vSeverityList)` Sets the value of '_severityList' by copying the given Vector.
`void`	`setSeverity(String[] vSeverityArray)`
`void`	`setSeverityCollection(List<String> severityList)` Deprecated.
`void`	`setUei(String uei)` Sets the value of field 'uei'.
`static UeiMatch`	`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
  - UeiMatch
```
public UeiMatch()
```
- Method Detail
  - addFacility
```
public void addFacility(String vFacility)
                 throws IndexOutOfBoundsException
```
    Parameters:
    vFacility -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addFacility
```
public void addFacility(int index,
               String vFacility)
                 throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vFacility -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addParameterAssignment
```
public void addParameterAssignment(ParameterAssignment vParameterAssignment)
                            throws IndexOutOfBoundsException
```
    Parameters:
    vParameterAssignment -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addParameterAssignment
```
public void addParameterAssignment(int index,
                          ParameterAssignment vParameterAssignment)
                            throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vParameterAssignment -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addSeverity
```
public void addSeverity(String vSeverity)
                 throws IndexOutOfBoundsException
```
    Parameters:
    vSeverity -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addSeverity
```
public void addSeverity(int index,
               String vSeverity)
                 throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vSeverity -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - enumerateFacility
```
public Enumeration<String> enumerateFacility()
```
    Method enumerateFacility.
    
    Returns:
    an Enumeration over all possible elements of this collection
  - enumerateParameterAssignment
```
public Enumeration<ParameterAssignment> enumerateParameterAssignment()
```
    Method enumerateParameterAssignment.
    
    Returns:
    an Enumeration over all possible elements of this collection
  - enumerateSeverity
```
public Enumeration<String> enumerateSeverity()
```
    Method enumerateSeverity.
    
    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.
  - getFacility
```
public String getFacility(int index)
                   throws IndexOutOfBoundsException
```
    Method getFacility.
    
    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
  - getFacility
```
public String[] getFacility()
```
    Method getFacility.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
  - getFacilityCollection
```
public List<String> getFacilityCollection()
```
    Method getFacilityCollection.Returns a reference to '_facilityList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    a reference to the Vector backing this class
  - getFacilityCount
```
public int getFacilityCount()
```
    Method getFacilityCount.
    
    Returns:
    the size of this collection
  - getHostaddrMatch
```
public HostaddrMatch getHostaddrMatch()
```
    Returns the value of field 'hostaddrMatch'. The field 'hostaddrMatch' has the following description: String against which to match the host IP address; interpreted as a regular expression.
    
    Returns:
    the value of field 'HostaddrMatch'.
  - getHostnameMatch
```
public HostnameMatch getHostnameMatch()
```
    Returns the value of field 'hostnameMatch'. The field 'hostnameMatch' has the following description: String against which to match the hostname; interpreted as a regular expression.
    
    Returns:
    the value of field 'HostnameMatch'.
  - getMatch
```
public Match getMatch()
```
    Returns the value of field 'match'. The field 'match' has the following description: String against which to match the message body; interpreted as a substring or a regular expression according to the value of the "type" attribute
    
    Returns:
    the value of field 'Match'.
  - getParameterAssignment
```
public ParameterAssignment getParameterAssignment(int index)
                                           throws IndexOutOfBoundsException
```
    Method getParameterAssignment.
    
    Parameters:
    index -
    
    Returns:
    the value of the org.opennms.netmgt.config.syslogd.ParameterAssignment at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getParameterAssignment
```
public ParameterAssignment[] getParameterAssignment()
```
    Method getParameterAssignment.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
  - getParameterAssignmentCollection
```
public List<ParameterAssignment> getParameterAssignmentCollection()
```
    Method getParameterAssignmentCollection.Returns a reference to '_parameterAssignmentList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    a reference to the Vector backing this class
  - getParameterAssignmentCount
```
public int getParameterAssignmentCount()
```
    Method getParameterAssignmentCount.
    
    Returns:
    the size of this collection
  - getProcessMatch
```
public ProcessMatch getProcessMatch()
```
    Returns the value of field 'processMatch'. The field 'processMatch' has the following description: String against which to match the process name; interpreted as a regular expression. If no process name is present in the incoming message, any process-match elements will be considered non-matches.
    
    Returns:
    the value of field 'ProcessMatch'.
  - getSeverity
```
public String getSeverity(int index)
                   throws IndexOutOfBoundsException
```
    Method getSeverity.
    
    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
  - getSeverity
```
public String[] getSeverity()
```
    Method getSeverity.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
  - getSeverityCollection
```
public List<String> getSeverityCollection()
```
    Method getSeverityCollection.Returns a reference to '_severityList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    a reference to the Vector backing this class
  - getSeverityCount
```
public int getSeverityCount()
```
    Method getSeverityCount.
    
    Returns:
    the size of this collection
  - getUei
```
public String getUei()
```
    Returns the value of field 'uei'. The field 'uei' has the following description: UEI
    
    Returns:
    the value of field 'Uei'.
  - 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
  - iterateFacility
```
public Iterator<String> iterateFacility()
```
    Method iterateFacility.
    
    Returns:
    an Iterator over all possible elements in this collection
  - iterateParameterAssignment
```
public Iterator<ParameterAssignment> iterateParameterAssignment()
```
    Method iterateParameterAssignment.
    
    Returns:
    an Iterator over all possible elements in this collection
  - iterateSeverity
```
public Iterator<String> iterateSeverity()
```
    Method iterateSeverity.
    
    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
  - removeAllFacility
```
public void removeAllFacility()
```
  - removeAllParameterAssignment
```
public void removeAllParameterAssignment()
```
  - removeAllSeverity
```
public void removeAllSeverity()
```
  - removeFacility
```
public boolean removeFacility(String vFacility)
```
    Method removeFacility.
    
    Parameters:
    vFacility -
    
    Returns:
    true if the object was removed from the collection.
  - removeFacilityAt
```
public String removeFacilityAt(int index)
```
    Method removeFacilityAt.
    
    Parameters:
    index -
    
    Returns:
    the element removed from the collection
  - removeParameterAssignment
```
public boolean removeParameterAssignment(ParameterAssignment vParameterAssignment)
```
    Method removeParameterAssignment.
    
    Parameters:
    vParameterAssignment -
    
    Returns:
    true if the object was removed from the collection.
  - removeParameterAssignmentAt
```
public ParameterAssignment removeParameterAssignmentAt(int index)
```
    Method removeParameterAssignmentAt.
    
    Parameters:
    index -
    
    Returns:
    the element removed from the collection
  - removeSeverity
```
public boolean removeSeverity(String vSeverity)
```
    Method removeSeverity.
    
    Parameters:
    vSeverity -
    
    Returns:
    true if the object was removed from the collection.
  - removeSeverityAt
```
public String removeSeverityAt(int index)
```
    Method removeSeverityAt.
    
    Parameters:
    index -
    
    Returns:
    the element removed from the collection
  - setFacility
```
public void setFacility(int index,
               String vFacility)
                 throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vFacility -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setFacility
```
public void setFacility(String[] vFacilityArray)
```
    Parameters:
    vFacilityArray -
  - setFacility
```
public void setFacility(List<String> vFacilityList)
```
    Sets the value of '_facilityList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    vFacilityList - the Vector to copy.
  - setFacilityCollection
```
public void setFacilityCollection(List<String> facilityList)
```
    Deprecated.
    
    Sets the value of '_facilityList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    facilityList - the Vector to set.
  - setHostaddrMatch
```
public void setHostaddrMatch(HostaddrMatch hostaddrMatch)
```
    Sets the value of field 'hostaddrMatch'. The field 'hostaddrMatch' has the following description: String against which to match the host IP address; interpreted as a regular expression.
    
    Parameters:
    hostaddrMatch - the value of field 'hostaddrMatch'.
  - setHostnameMatch
```
public void setHostnameMatch(HostnameMatch hostnameMatch)
```
    Sets the value of field 'hostnameMatch'. The field 'hostnameMatch' has the following description: String against which to match the hostname; interpreted as a regular expression.
    
    Parameters:
    hostnameMatch - the value of field 'hostnameMatch'.
  - setMatch
```
public void setMatch(Match match)
```
    Sets the value of field 'match'. The field 'match' has the following description: String against which to match the message body; interpreted as a substring or a regular expression according to the value of the "type" attribute
    
    Parameters:
    match - the value of field 'match'.
  - setParameterAssignment
```
public void setParameterAssignment(int index,
                          ParameterAssignment vParameterAssignment)
                            throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vParameterAssignment -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setParameterAssignment
```
public void setParameterAssignment(ParameterAssignment[] vParameterAssignmentArray)
```
    Parameters:
    vParameterAssignmentArray -
  - setParameterAssignment
```
public void setParameterAssignment(List<ParameterAssignment> vParameterAssignmentList)
```
    Sets the value of '_parameterAssignmentList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    vParameterAssignmentList - the Vector to copy.
  - setParameterAssignmentCollection
```
public void setParameterAssignmentCollection(List<ParameterAssignment> parameterAssignmentList)
```
    Deprecated.
    
    Sets the value of '_parameterAssignmentList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    parameterAssignmentList - the Vector to set.
  - setProcessMatch
```
public void setProcessMatch(ProcessMatch processMatch)
```
    Sets the value of field 'processMatch'. The field 'processMatch' has the following description: String against which to match the process name; interpreted as a regular expression. If no process name is present in the incoming message, any process-match elements will be considered non-matches.
    
    Parameters:
    processMatch - the value of field 'processMatch'.
  - setSeverity
```
public void setSeverity(int index,
               String vSeverity)
                 throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vSeverity -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setSeverity
```
public void setSeverity(String[] vSeverityArray)
```
    Parameters:
    vSeverityArray -
  - setSeverity
```
public void setSeverity(List<String> vSeverityList)
```
    Sets the value of '_severityList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    vSeverityList - the Vector to copy.
  - setSeverityCollection
```
public void setSeverityCollection(List<String> severityList)
```
    Deprecated.
    
    Sets the value of '_severityList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    severityList - the Vector to set.
  - setUei
```
public void setUei(String uei)
```
    Sets the value of field 'uei'. The field 'uei' has the following description: UEI
    
    Parameters:
    uei - the value of field 'uei'.
  - unmarshal
```
public static UeiMatch 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.syslogd.UeiMatch
    
    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

Class UeiMatch

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UeiMatch

Method Detail

addFacility

addFacility

addParameterAssignment

addParameterAssignment

addSeverity

addSeverity

enumerateFacility

enumerateParameterAssignment

enumerateSeverity

equals

getFacility

getFacility

getFacilityCollection

getFacilityCount

getHostaddrMatch

getHostnameMatch

getMatch

getParameterAssignment

getParameterAssignment

getParameterAssignmentCollection

getParameterAssignmentCount

getProcessMatch

getSeverity

getSeverity

getSeverityCollection

getSeverityCount

getUei

hashCode

isValid

iterateFacility

iterateParameterAssignment

iterateSeverity

marshal

marshal

removeAllFacility

removeAllParameterAssignment

removeAllSeverity

removeFacility

removeFacilityAt

removeParameterAssignment

removeParameterAssignmentAt

removeSeverity

removeSeverityAt

setFacility

setFacility

setFacility

setFacilityCollection

setHostaddrMatch

setHostnameMatch

setMatch

setParameterAssignment

setParameterAssignment

setParameterAssignment

setParameterAssignmentCollection

setProcessMatch

setSeverity

setSeverity

setSeverity

setSeverityCollection

setUei

unmarshal

validate