org.opennms.netmgt.config.discovery
Class IncludeUrl

java.lang.Object
  extended by org.opennms.netmgt.config.discovery.IncludeUrl
All Implemented Interfaces:
Serializable

public class IncludeUrl
extends Object
implements Serializable

A file URL holding specific addresses to be polled. Each line in the URL file can be one of: "#", "", or "#". Lines starting with a '#' are ignored and so are characters after a '#' in a line.

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

Constructor Summary
IncludeUrl()
           
 
Method Summary
 void deleteRetries()
           
 void deleteTimeout()
           
 boolean equals(Object obj)
          Overrides the java.lang.Object.equals method.
 String getContent()
          Returns the value of field 'content'.
 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 setContent(String content)
          Sets the value of field 'content'.
 void setRetries(int retries)
          Sets the value of field 'retries'.
 void setTimeout(long timeout)
          Sets the value of field 'timeout'.
static IncludeUrl 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

IncludeUrl

public IncludeUrl()
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.

getContent

public String getContent()
Returns the value of field 'content'. The field 'content' has the following description: internal content storage

Returns:
the value of field 'Content'.

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 addresses listed in this file. 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 addresses listed in this file. 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

setContent

public void setContent(String content)
Sets the value of field 'content'. The field 'content' has the following description: internal content storage

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

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 addresses listed in this file. 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 addresses listed in this file. This timeout overrides the default.

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

unmarshal

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


Copyright © 2011. All Rights Reserved.