OpenNMS API 1.2.3

org.opennms.netmgt.config.capsd
Class ProtocolConfiguration

java.lang.Object
  extended byorg.opennms.netmgt.config.capsd.ProtocolConfiguration
All Implemented Interfaces:
java.io.Serializable

public class ProtocolConfiguration
extends java.lang.Object
implements java.io.Serializable

Version:
$Revision$ $Date$
See Also:
Serialized Form

Field Summary
private  java.util.ArrayList _propertyList
           
private  java.util.ArrayList _rangeList
           
private  java.lang.String _scan
           
private  java.util.ArrayList _specificList
           
private  java.lang.String _userDefined
           
private  java.util.Vector propertyChangeListeners
           
 
Constructor Summary
ProtocolConfiguration()
           
 
Method Summary
 void addProperty(int index, Property vProperty)
           
 void addProperty(Property vProperty)
           
 void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
          Registers a PropertyChangeListener with this class.
 void addRange(int index, Range vRange)
           
 void addRange(Range vRange)
           
 void addSpecific(int index, java.lang.String vSpecific)
           
 void addSpecific(java.lang.String vSpecific)
           
 void clearProperty()
           
 void clearRange()
           
 void clearSpecific()
           
 java.util.Enumeration enumerateProperty()
           
 java.util.Enumeration enumerateRange()
           
 java.util.Enumeration enumerateSpecific()
           
 boolean equals(java.lang.Object obj)
          Note: hashCode() has not been overriden
 Property[] getProperty()
           
 Property getProperty(int index)
           
 java.util.Collection getPropertyCollection()
           
 int getPropertyCount()
           
 Range[] getRange()
           
 Range getRange(int index)
           
 java.util.Collection getRangeCollection()
           
 int getRangeCount()
           
 java.lang.String getScan()
          Returns the value of field 'scan'.
 java.lang.String[] getSpecific()
           
 java.lang.String getSpecific(int index)
           
 java.util.Collection getSpecificCollection()
           
 int getSpecificCount()
           
 java.lang.String getUserDefined()
          Returns the value of field 'userDefined'.
 boolean isValid()
           
 void marshal(org.xml.sax.DocumentHandler handler)
           
 void marshal(java.io.Writer out)
           
protected  void notifyPropertyChangeListeners(java.lang.String fieldName, java.lang.Object oldValue, java.lang.Object newValue)
          Notifies all registered PropertyChangeListeners when a bound property's value changes.
 boolean removeProperty(Property vProperty)
           
 boolean removePropertyChangeListener(java.beans.PropertyChangeListener pcl)
          Removes the given PropertyChangeListener from this classes list of ProperyChangeListeners.
 boolean removeRange(Range vRange)
           
 boolean removeSpecific(java.lang.String vSpecific)
           
 void setProperty(int index, Property vProperty)
           
 void setProperty(Property[] propertyArray)
           
 void setPropertyCollection(java.util.Collection vProperty)
           
 void setRange(int index, Range vRange)
           
 void setRange(Range[] rangeArray)
           
 void setRangeCollection(java.util.Collection vRange)
           
 void setScan(java.lang.String scan)
          Sets the value of field 'scan'.
 void setSpecific(int index, java.lang.String vSpecific)
           
 void setSpecific(java.lang.String[] specificArray)
           
 void setSpecificCollection(java.util.Collection vSpecific)
           
 void setUserDefined(java.lang.String userDefined)
          Sets the value of field 'userDefined'.
static ProtocolConfiguration unmarshal(java.io.Reader reader)
           
 void validate()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_scan

private java.lang.String _scan

_userDefined

private java.lang.String _userDefined

_specificList

private java.util.ArrayList _specificList

_rangeList

private java.util.ArrayList _rangeList

_propertyList

private java.util.ArrayList _propertyList

propertyChangeListeners

private java.util.Vector propertyChangeListeners
Constructor Detail

ProtocolConfiguration

public ProtocolConfiguration()
Method Detail

addProperty

public void addProperty(Property vProperty)
                 throws java.lang.IndexOutOfBoundsException
Parameters:
vProperty -
Throws:
java.lang.IndexOutOfBoundsException

addProperty

public void addProperty(int index,
                        Property vProperty)
                 throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vProperty -
Throws:
java.lang.IndexOutOfBoundsException

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
Registers a PropertyChangeListener with this class.

Parameters:
pcl - The PropertyChangeListener to register.

addRange

public void addRange(Range vRange)
              throws java.lang.IndexOutOfBoundsException
Parameters:
vRange -
Throws:
java.lang.IndexOutOfBoundsException

addRange

public void addRange(int index,
                     Range vRange)
              throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vRange -
Throws:
java.lang.IndexOutOfBoundsException

addSpecific

public void addSpecific(java.lang.String vSpecific)
                 throws java.lang.IndexOutOfBoundsException
Parameters:
vSpecific -
Throws:
java.lang.IndexOutOfBoundsException

addSpecific

public void addSpecific(int index,
                        java.lang.String vSpecific)
                 throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vSpecific -
Throws:
java.lang.IndexOutOfBoundsException

clearProperty

public void clearProperty()

clearRange

public void clearRange()

clearSpecific

public void clearSpecific()

enumerateProperty

public java.util.Enumeration enumerateProperty()

enumerateRange

public java.util.Enumeration enumerateRange()

enumerateSpecific

public java.util.Enumeration enumerateSpecific()

equals

public boolean equals(java.lang.Object obj)
Note: hashCode() has not been overriden

Parameters:
obj -

getProperty

public Property getProperty(int index)
                     throws java.lang.IndexOutOfBoundsException
Parameters:
index -
Throws:
java.lang.IndexOutOfBoundsException

getProperty

public Property[] getProperty()

getPropertyCollection

public java.util.Collection getPropertyCollection()

getPropertyCount

public int getPropertyCount()

getRange

public Range getRange(int index)
               throws java.lang.IndexOutOfBoundsException
Parameters:
index -
Throws:
java.lang.IndexOutOfBoundsException

getRange

public Range[] getRange()

getRangeCollection

public java.util.Collection getRangeCollection()

getRangeCount

public int getRangeCount()

getScan

public java.lang.String getScan()
Returns the value of field 'scan'.

Returns:
the value of field 'scan'.

getSpecific

public java.lang.String getSpecific(int index)
                             throws java.lang.IndexOutOfBoundsException
Parameters:
index -
Throws:
java.lang.IndexOutOfBoundsException

getSpecific

public java.lang.String[] getSpecific()

getSpecificCollection

public java.util.Collection getSpecificCollection()

getSpecificCount

public int getSpecificCount()

getUserDefined

public java.lang.String getUserDefined()
Returns the value of field 'userDefined'.

Returns:
the value of field 'userDefined'.

isValid

public boolean isValid()

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
out -
Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.DocumentHandler handler)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
handler -
Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

notifyPropertyChangeListeners

protected void notifyPropertyChangeListeners(java.lang.String fieldName,
                                             java.lang.Object oldValue,
                                             java.lang.Object newValue)
Notifies all registered PropertyChangeListeners when a bound property's value changes.

Parameters:
fieldName - the name of the property that has changed.
newValue - the new value of the property.
oldValue - the old value of the property.

removeProperty

public boolean removeProperty(Property vProperty)
Parameters:
vProperty -

removePropertyChangeListener

public boolean removePropertyChangeListener(java.beans.PropertyChangeListener pcl)
Removes the given PropertyChangeListener from this classes list of ProperyChangeListeners.

Parameters:
pcl - The PropertyChangeListener to remove.
Returns:
true if the given PropertyChangeListener was removed.

removeRange

public boolean removeRange(Range vRange)
Parameters:
vRange -

removeSpecific

public boolean removeSpecific(java.lang.String vSpecific)
Parameters:
vSpecific -

setProperty

public void setProperty(int index,
                        Property vProperty)
                 throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vProperty -
Throws:
java.lang.IndexOutOfBoundsException

setProperty

public void setProperty(Property[] propertyArray)
Parameters:
propertyArray -

setPropertyCollection

public void setPropertyCollection(java.util.Collection vProperty)
Parameters:
vProperty -

setRange

public void setRange(int index,
                     Range vRange)
              throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vRange -
Throws:
java.lang.IndexOutOfBoundsException

setRange

public void setRange(Range[] rangeArray)
Parameters:
rangeArray -

setRangeCollection

public void setRangeCollection(java.util.Collection vRange)
Parameters:
vRange -

setScan

public void setScan(java.lang.String scan)
Sets the value of field 'scan'.

Parameters:
scan - the value of field 'scan'.

setSpecific

public void setSpecific(int index,
                        java.lang.String vSpecific)
                 throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vSpecific -
Throws:
java.lang.IndexOutOfBoundsException

setSpecific

public void setSpecific(java.lang.String[] specificArray)
Parameters:
specificArray -

setSpecificCollection

public void setSpecificCollection(java.util.Collection vSpecific)
Parameters:
vSpecific -

setUserDefined

public void setUserDefined(java.lang.String userDefined)
Sets the value of field 'userDefined'.

Parameters:
userDefined - the value of field 'userDefined'.

unmarshal

public static ProtocolConfiguration unmarshal(java.io.Reader reader)
                                       throws org.exolab.castor.xml.MarshalException,
                                              org.exolab.castor.xml.ValidationException
Parameters:
reader -
Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Throws:
org.exolab.castor.xml.ValidationException

OpenNMS API 1.2.3

Generated by eevans on May 29 2005 2015.