com.bmc.arsys.plugins.ftsconfig.helper.shared

Class AbstractConfigurationFile

java.lang.Object

com.bmc.arsys.plugins.ftsconfig.helper.shared.AbstractConfigurationFile

All Implemented Interfaces:

AbstractEntryContainer, Iterable<AbstractEntry>

Direct Known Subclasses:

PropertiesConfigurationFile

public abstract class AbstractConfigurationFile
extends Object
implements AbstractEntryContainer

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurationFile() Constructor for AbstractConfigurationFile

Method Summary

Methods

Modifier and Type	Method and Description
void	addEntry(AbstractEntry entry) Adds an entry
void	addEntry(int index, AbstractEntry entry) Adds an entry at an index
boolean	equals(Object obj) Tests whether this Object is equal to another one
ConfigurationFileListIterator	getConfigurationFileListIterator()
List<AbstractEntry>	getEntries() Gets the entries
AbstractEntry	getEntry(int index) Gets an entry at a given index
int	hashCode() Gets the hash code for this Object
int	indexOfEntry(AbstractEntry entry) Gets the index of an AbstractEntry
Iterator<AbstractEntry>	iterator() Gets an Iterator for the AbstractEntries
abstract void	parse(File file) Parses a File
void	removeEntry(AbstractEntry entry) Removes an entry
void	save(File file) Writes the current configuration to a File
String	toString() Gets a String representation of this Object

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.bmc.arsys.plugins.ftsconfig.helper.shared.AbstractEntryContainer

allowsEntryType

Constructor Detail

AbstractConfigurationFile

public AbstractConfigurationFile()

Constructor for AbstractConfigurationFile

Method Detail

parse

public abstract void parse(File file)
                    throws FileNotFoundException,
                           IOException,
                           ParseException

Parses a File

Parameters:

file - File to parse

Throws:

FileNotFoundException - if the File is not found

IOException - for all other I/O errors

ParseException - for any parsing errors

save

public void save(File file)
          throws FileNotFoundException,
                 IOException

Writes the current configuration to a File

Parameters:

file - File to write to

Throws:

FileNotFoundException - if the File is not found

IOException - for all other I/O errors

iterator

public Iterator<AbstractEntry> iterator()

Gets an Iterator for the AbstractEntries

Specified by:

iterator in interface AbstractEntryContainer

Specified by:

iterator in interface Iterable<AbstractEntry>

Returns:

Iterator for the AbstractEntries

getEntries

public List<AbstractEntry> getEntries()

Gets the entries

Specified by:

getEntries in interface AbstractEntryContainer

Returns:

entries

addEntry

public void addEntry(AbstractEntry entry)

Adds an entry

Specified by:

addEntry in interface AbstractEntryContainer

Parameters:

entry - entry to add

addEntry

public void addEntry(int index,
            AbstractEntry entry)

Adds an entry at an index

Specified by:

addEntry in interface AbstractEntryContainer

Parameters:

index - index

entry - entry to add

getEntry

public AbstractEntry getEntry(int index)

Gets an entry at a given index

Specified by:

getEntry in interface AbstractEntryContainer

Parameters:

index - index to examine

Returns:

entry at that index or null if it does not exist

indexOfEntry

public int indexOfEntry(AbstractEntry entry)

Gets the index of an AbstractEntry

Specified by:

indexOfEntry in interface AbstractEntryContainer

Parameters:

entry - entry to look for

Returns:

index of element, or -1 if entry does not exist

removeEntry

public void removeEntry(AbstractEntry entry)

Removes an entry

Specified by:

removeEntry in interface AbstractEntryContainer

Parameters:

entry - entry to remove

equals

public boolean equals(Object obj)

Tests whether this Object is equal to another one

Overrides:

equals in class Object

Parameters:

obj - Object to test for equality

Returns:

true if these Objects are equal, false otherwise

hashCode

public int hashCode()

Gets the hash code for this Object

Overrides:

hashCode in class Object

Returns:

hash code for this Object

toString

public String toString()

Gets a String representation of this Object

Overrides:

toString in class Object

Returns:

String representation of this Object

getConfigurationFileListIterator

public ConfigurationFileListIterator getConfigurationFileListIterator()