OpenNMS API 1.2.3

org.opennms.netmgt.config.capsd
Class Definition

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

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

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

Field Summary
private  boolean _has_port
          keeps track of state for field: _port
private  boolean _has_retry
          keeps track of state for field: _retry
private  boolean _has_timeout
          keeps track of state for field: _timeout
private  int _port
           
private  java.util.ArrayList _rangeList
           
private  java.lang.String _readCommunity
           
private  int _retry
           
private  java.util.ArrayList _specificList
           
private  int _timeout
           
private  java.lang.String _version
           
private  java.lang.String _writeCommunity
           
private  java.util.Vector propertyChangeListeners
           
 
Constructor Summary
Definition()
           
 
Method Summary
 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 clearRange()
           
 void clearSpecific()
           
 void deletePort()
           
 void deleteRetry()
           
 void deleteTimeout()
           
 java.util.Enumeration enumerateRange()
           
 java.util.Enumeration enumerateSpecific()
           
 boolean equals(java.lang.Object obj)
          Note: hashCode() has not been overriden
 int getPort()
          Returns the value of field 'port'.
 Range[] getRange()
           
 Range getRange(int index)
           
 java.util.Collection getRangeCollection()
           
 int getRangeCount()
           
 java.lang.String getReadCommunity()
          Returns the value of field 'readCommunity'.
 int getRetry()
          Returns the value of field 'retry'.
 java.lang.String[] getSpecific()
           
 java.lang.String getSpecific(int index)
           
 java.util.Collection getSpecificCollection()
           
 int getSpecificCount()
           
 int getTimeout()
          Returns the value of field 'timeout'.
 java.lang.String getVersion()
          Returns the value of field 'version'.
 java.lang.String getWriteCommunity()
          Returns the value of field 'writeCommunity'.
 boolean hasPort()
           
 boolean hasRetry()
           
 boolean hasTimeout()
           
 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 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 setPort(int port)
          Sets the value of field 'port'.
 void setRange(int index, Range vRange)
           
 void setRange(Range[] rangeArray)
           
 void setRangeCollection(java.util.Collection vRange)
           
 void setReadCommunity(java.lang.String readCommunity)
          Sets the value of field 'readCommunity'.
 void setRetry(int retry)
          Sets the value of field 'retry'.
 void setSpecific(int index, java.lang.String vSpecific)
           
 void setSpecific(java.lang.String[] specificArray)
           
 void setSpecificCollection(java.util.Collection vSpecific)
           
 void setTimeout(int timeout)
          Sets the value of field 'timeout'.
 void setVersion(java.lang.String version)
          Sets the value of field 'version'.
 void setWriteCommunity(java.lang.String writeCommunity)
          Sets the value of field 'writeCommunity'.
static Definition 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

_retry

private int _retry

_has_retry

private boolean _has_retry
keeps track of state for field: _retry


_timeout

private int _timeout

_has_timeout

private boolean _has_timeout
keeps track of state for field: _timeout


_readCommunity

private java.lang.String _readCommunity

_writeCommunity

private java.lang.String _writeCommunity

_port

private int _port

_has_port

private boolean _has_port
keeps track of state for field: _port


_version

private java.lang.String _version

_rangeList

private java.util.ArrayList _rangeList

_specificList

private java.util.ArrayList _specificList

propertyChangeListeners

private java.util.Vector propertyChangeListeners
Constructor Detail

Definition

public Definition()
Method Detail

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

clearRange

public void clearRange()

clearSpecific

public void clearSpecific()

deletePort

public void deletePort()

deleteRetry

public void deleteRetry()

deleteTimeout

public void deleteTimeout()

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 -

getPort

public int getPort()
Returns the value of field 'port'.

Returns:
the value of field 'port'.

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()

getReadCommunity

public java.lang.String getReadCommunity()
Returns the value of field 'readCommunity'.

Returns:
the value of field 'readCommunity'.

getRetry

public int getRetry()
Returns the value of field 'retry'.

Returns:
the value of field 'retry'.

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()

getTimeout

public int getTimeout()
Returns the value of field 'timeout'.

Returns:
the value of field 'timeout'.

getVersion

public java.lang.String getVersion()
Returns the value of field 'version'.

Returns:
the value of field 'version'.

getWriteCommunity

public java.lang.String getWriteCommunity()
Returns the value of field 'writeCommunity'.

Returns:
the value of field 'writeCommunity'.

hasPort

public boolean hasPort()

hasRetry

public boolean hasRetry()

hasTimeout

public boolean hasTimeout()

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.

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 -

setPort

public void setPort(int port)
Sets the value of field 'port'.

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

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 -

setReadCommunity

public void setReadCommunity(java.lang.String readCommunity)
Sets the value of field 'readCommunity'.

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

setRetry

public void setRetry(int retry)
Sets the value of field 'retry'.

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

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 -

setTimeout

public void setTimeout(int timeout)
Sets the value of field 'timeout'.

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

setVersion

public void setVersion(java.lang.String version)
Sets the value of field 'version'.

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

setWriteCommunity

public void setWriteCommunity(java.lang.String writeCommunity)
Sets the value of field 'writeCommunity'.

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

unmarshal

public static Definition 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.