org.opennms.netmgt.config.syslogd

Class SyslogdConfiguration

java.lang.Object

org.opennms.netmgt.config.syslogd.SyslogdConfiguration

All Implemented Interfaces:

Serializable

public class SyslogdConfiguration
extends Object
implements Serializable

Class SyslogdConfiguration.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SyslogdConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addImportFile(int index, String vImportFile)
void	addImportFile(String vImportFile)
Enumeration<String>	enumerateImportFile() Method enumerateImportFile.
boolean	equals(Object obj) Overrides the Object.equals method.
Configuration	getConfiguration() Returns the value of field 'configuration'.
HideMessage	getHideMessage() Returns the value of field 'hideMessage'.
String[]	getImportFile() Method getImportFile.Returns the contents of the collection in an Array.
String	getImportFile(int index) Method getImportFile.
List<String>	getImportFileCollection() Method getImportFileCollection.Returns a reference to 'importFileList'.
int	getImportFileCount() Method getImportFileCount.
UeiList	getUeiList() Returns the value of field 'ueiList'.
int	hashCode() Method hashCode.
Iterator<String>	iterateImportFile() Method iterateImportFile.
void	removeAllImportFile()
boolean	removeImportFile(String vImportFile) Method removeImportFile.
String	removeImportFileAt(int index) Method removeImportFileAt.
void	setConfiguration(Configuration configuration) Sets the value of field 'configuration'.
void	setHideMessage(HideMessage hideMessage) Sets the value of field 'hideMessage'.
void	setImportFile(int index, String vImportFile)
void	setImportFile(List<String> vImportFileList) Sets the value of 'importFileList' by copying the given Vector.
void	setImportFile(String[] vImportFileArray)
void	setImportFileCollection(List<String> importFileList) Deprecated.
void	setUeiList(UeiList ueiList) Sets the value of field 'ueiList'.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SyslogdConfiguration

public SyslogdConfiguration()

Method Detail

addImportFile

public void addImportFile(String vImportFile)
                   throws IndexOutOfBoundsException

Parameters:

vImportFile -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addImportFile

public void addImportFile(int index,
                          String vImportFile)
                   throws IndexOutOfBoundsException

Parameters:

index -

vImportFile -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateImportFile

public Enumeration<String> enumerateImportFile()

Method enumerateImportFile.

Returns:

an Enumeration over all possible elements of this collection

equals

public boolean equals(Object obj)

Overrides the Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getConfiguration

public Configuration getConfiguration()

Returns the value of field 'configuration'. The field 'configuration' has the following description: Top-level element for the syslogd-configuration.xml configuration file.

Returns:

the value of field 'Configuration'.

getHideMessage

public HideMessage getHideMessage()

Returns the value of field 'hideMessage'.

Returns:

the value of field 'HideMessage'.

getImportFile

public String getImportFile(int index)
                     throws IndexOutOfBoundsException

Method getImportFile.

Parameters:

index -

Returns:

the value of the String at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getImportFile

public String[] getImportFile()

Method getImportFile.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

getImportFileCollection

public List<String> getImportFileCollection()

Method getImportFileCollection.Returns a reference to 'importFileList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getImportFileCount

public int getImportFileCount()

Method getImportFileCount.

Returns:

the size of this collection

getUeiList

public UeiList getUeiList()

Returns the value of field 'ueiList'.

Returns:

the value of field 'UeiList'.

hashCode

public int hashCode()

Method hashCode.

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

iterateImportFile

public Iterator<String> iterateImportFile()

Method iterateImportFile.

Returns:

an Iterator over all possible elements in this collection

removeAllImportFile

public void removeAllImportFile()

removeImportFile

public boolean removeImportFile(String vImportFile)

Method removeImportFile.

Parameters:

vImportFile -

Returns:

true if the object was removed from the collection.

removeImportFileAt

public String removeImportFileAt(int index)

Method removeImportFileAt.

Parameters:

index -

Returns:

the element removed from the collection

setConfiguration

public void setConfiguration(Configuration configuration)

Sets the value of field 'configuration'. The field 'configuration' has the following description: Top-level element for the syslogd-configuration.xml configuration file.

Parameters:

configuration - the value of field 'configuration'.

setHideMessage

public void setHideMessage(HideMessage hideMessage)

Sets the value of field 'hideMessage'.

Parameters:

hideMessage - the value of field 'hideMessage'.

setImportFile

public void setImportFile(int index,
                          String vImportFile)
                   throws IndexOutOfBoundsException

Parameters:

index -

vImportFile -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setImportFile

public void setImportFile(String[] vImportFileArray)

Parameters:

vImportFileArray -

setImportFile

public void setImportFile(List<String> vImportFileList)

Sets the value of 'importFileList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vImportFileList - the Vector to copy.

setImportFileCollection

public void setImportFileCollection(List<String> importFileList)

Deprecated.

Sets the value of 'importFileList' by setting it to the given Vector. No type checking is performed.

Parameters:

importFileList - the Vector to set.

setUeiList

public void setUeiList(UeiList ueiList)

Sets the value of field 'ueiList'.

Parameters:

ueiList - the value of field 'ueiList'.