org.opennms.netmgt.config.discovery

Class IncludeRange

java.lang.Object

org.opennms.netmgt.config.discovery.IncludeRange

All Implemented Interfaces:

Serializable

public class IncludeRange
extends Object
implements Serializable

A range of addresses to be polled.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IncludeRange()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteRetries()
void	deleteTimeout()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getBegin() Returns the value of field 'begin'.
String	getEnd() Returns the value of field 'end'.
String	getForeignSource() Returns the value of field 'foreignSource'.
int	getRetries() Returns the value of field 'retries'.
long	getTimeout() Returns the value of field 'timeout'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasRetries() Method hasRetries.
boolean	hasTimeout() Method hasTimeout.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setBegin(String begin) Sets the value of field 'begin'.
void	setEnd(String end) Sets the value of field 'end'.
void	setForeignSource(String foreignSource) Sets the value of field 'foreignSource'.
void	setRetries(int retries) Sets the value of field 'retries'.
void	setTimeout(long timeout) Sets the value of field 'timeout'.
static IncludeRange	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

IncludeRange

public IncludeRange()

Method Detail

deleteRetries

public void deleteRetries()

deleteTimeout

public void deleteTimeout()

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.

getBegin

public String getBegin()

Returns the value of field 'begin'. The field 'begin' has the following description: Starting address of the range.

Returns:

the value of field 'Begin'.

getEnd

public String getEnd()

Returns the value of field 'end'. The field 'end' has the following description: Ending address of the range. If the starting address is greater than the ending address, they are swapped.

Returns:

the value of field 'End'.

getForeignSource

public String getForeignSource()

Returns the value of field 'foreignSource'.

Returns:

the value of field 'ForeignSource'.

getRetries

public int getRetries()

Returns the value of field 'retries'. The field 'retries' has the following description: The number of times a ping is retried for this address range. If there is no response after the first ping to an address, it is tried again for the specified number of retries. This retry count overrides the default.

Returns:

the value of field 'Retries'.

getTimeout

public long getTimeout()

Returns the value of field 'timeout'. The field 'timeout' has the following description: The timeout on each poll for this address range. This timeout overrides the default.

Returns:

the value of field 'Timeout'.

hasRetries

public boolean hasRetries()

Method hasRetries.

Returns:

true if at least one Retries has been added

hasTimeout

public boolean hasTimeout()

Method hasTimeout.

Returns:

true if at least one Timeout has been added

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

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

setBegin

public void setBegin(String begin)

Sets the value of field 'begin'. The field 'begin' has the following description: Starting address of the range.

Parameters:

begin - the value of field 'begin'.

setEnd

public void setEnd(String end)

Sets the value of field 'end'. The field 'end' has the following description: Ending address of the range. If the starting address is greater than the ending address, they are swapped.

Parameters:

end - the value of field 'end'.

setForeignSource

public void setForeignSource(String foreignSource)

Sets the value of field 'foreignSource'.

Parameters:

foreignSource - the value of field 'foreignSource'.

setRetries

public void setRetries(int retries)

Sets the value of field 'retries'. The field 'retries' has the following description: The number of times a ping is retried for this address range. If there is no response after the first ping to an address, it is tried again for the specified number of retries. This retry count overrides the default.

Parameters:

retries - the value of field 'retries'.

setTimeout

public void setTimeout(long timeout)

Sets the value of field 'timeout'. The field 'timeout' has the following description: The timeout on each poll for this address range. This timeout overrides the default.

Parameters:

timeout - the value of field 'timeout'.

unmarshal

public static IncludeRange 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.discovery.IncludeRange

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