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

Interface AbstractEntryContainer

All Superinterfaces:

Iterable<AbstractEntry>

All Known Implementing Classes:

AbstractConfigurationFile, PropertiesConfigurationFile

public interface AbstractEntryContainer
extends Iterable<AbstractEntry>

AbstractEntryContainer is a base interface for any object that can contain AbstractEntry items

Method Summary

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	allowsEntryType(AbstractEntry entry) Determines if an entry type is allowed in this configuration File
List<AbstractEntry>	getEntries() Gets the entries
AbstractEntry	getEntry(int index) Gets an entry at a given index
int	indexOfEntry(AbstractEntry entry) Gets the index of an AbstractEntry
Iterator<AbstractEntry>	iterator() Gets an Iterator for the AbstractEntries
void	removeEntry(AbstractEntry entry) Removes an entry

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

Iterator<AbstractEntry> iterator()

Gets an Iterator for the AbstractEntries

Specified by:

iterator in interface Iterable<AbstractEntry>

Returns:

Iterator for the AbstractEntries

getEntries

List<AbstractEntry> getEntries()

Gets the entries

Returns:

entries

allowsEntryType

boolean allowsEntryType(AbstractEntry entry)

Determines if an entry type is allowed in this configuration File

Parameters:

entry - entry to examine

Returns:

true if this type of entry is allowed, false otherwise

addEntry

void addEntry(AbstractEntry entry)

Adds an entry

Parameters:

entry - entry to add

addEntry

void addEntry(int index,
              AbstractEntry entry)

Adds an entry at an index

Parameters:

index - index

entry - entry to add

getEntry

AbstractEntry getEntry(int index)

Gets an entry at a given index

Parameters:

index - index to examine

Returns:

entry at that index or null if it does not exist

indexOfEntry

int indexOfEntry(AbstractEntry entry)

Gets the index of an AbstractEntry

Parameters:

entry - entry to look for

Returns:

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

removeEntry

void removeEntry(AbstractEntry entry)

Removes an entry

Parameters:

entry - entry to remove