com.sshtools.config.file.entry

Class Entry

java.lang.Object

com.sshtools.config.file.entry.Entry

Direct Known Subclasses:

GlobalEntry

public class Entry
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Entry.AbstractEntryBuilder<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,FileEntryType.SshdConfigFileEntry>	keyEntries
protected SshdConfigFile	sshdConfigFile

Constructor Summary

Constructors

Constructor and Description
Entry(SshdConfigFile sshdConfigFile)

Method Summary

Modifier and Type	Method and Description
void	addBeginingComment(FileEntryType.CommentEntry commentEntry) Will add a comment entry at the beginning of the section.
void	addCommentForEntry(String key, FileEntryType.CommentEntry commentEntry)
int	addEntry(int index, FileEntryType.SshdConfigFileEntry sshdConfigFileEntry) This method would add entry after the past valid entry.
void	appendEntry(FileEntryType.SshdConfigFileEntry sshdConfigFileEntry) This will simply keep adding entries in a section, will not make any decision to check to add new entry after a valid entry.
void	deleteEntry(String key) Will delete the entry for the given key.
Boolean	entryMatches(String key, Collection<String> patterns)
protected <T> T	executeRead(Callable<T> callable)
protected <T> T	executeWrite(Callable<T> callable)
FileEntryType.SshdConfigFileEntry	findEntry(String key)
FileEntryType.SshdConfigFileEntry	findEntryAtIndex(int index)
int	findEntryIndex(String key)
FileEntryType.SshdConfigKeyValueEntry	findKeyValueEntry(String key)
String	getBlankEntryKey()
String	getCommentEntryKey()
FileEntryType.SshdConfigFileEntry	getEntry(String key)
Map<String,FileEntryType.SshdConfigFileEntry>	getKeyEntries()
protected org.apache.commons.collections.map.ListOrderedMap	getKeyEntriesOrderedMap()
void	updateEntry(String key, String value) Will update the value for the given key with new entry

Methods inherited from class java.lang.Object

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

Field Detail

sshdConfigFile

protected SshdConfigFile sshdConfigFile

keyEntries

protected Map<String,FileEntryType.SshdConfigFileEntry> keyEntries

Constructor Detail

Entry

public Entry(SshdConfigFile sshdConfigFile)

Method Detail

getKeyEntriesOrderedMap

protected org.apache.commons.collections.map.ListOrderedMap getKeyEntriesOrderedMap()

getEntry

public FileEntryType.SshdConfigFileEntry getEntry(String key)

getKeyEntries

public Map<String,FileEntryType.SshdConfigFileEntry> getKeyEntries()

findEntry

public FileEntryType.SshdConfigFileEntry findEntry(String key)

findKeyValueEntry

public FileEntryType.SshdConfigKeyValueEntry findKeyValueEntry(String key)

findEntryIndex

public int findEntryIndex(String key)

findEntryAtIndex

public FileEntryType.SshdConfigFileEntry findEntryAtIndex(int index)

addCommentForEntry

public void addCommentForEntry(String key,
                               FileEntryType.CommentEntry commentEntry)

addBeginingComment

public void addBeginingComment(FileEntryType.CommentEntry commentEntry)

Will add a comment entry at the beginning of the section.

Parameters:

commentEntry -

updateEntry

public void updateEntry(String key,
                        String value)

Will update the value for the given key with new entry

Parameters:

key -

entry -

deleteEntry

public void deleteEntry(String key)

Will delete the entry for the given key.

Parameters:

key -

addEntry

public int addEntry(int index,
                    FileEntryType.SshdConfigFileEntry sshdConfigFileEntry)

This method would add entry after the past valid entry. If the section ends with a series of blank and comment lines. It will walk backwards from the end of the section, find the valid entry index and add the entry post that.
Use this when editing an already existing file.

Parameters:

index -

sshdConfigFileEntry -

appendEntry

public void appendEntry(FileEntryType.SshdConfigFileEntry sshdConfigFileEntry)

This will simply keep adding entries in a section, will not make any decision to check to add new entry after a valid entry.
Use this to create a fresh file.

Parameters:

sshdConfigFileEntry -

entryMatches

public Boolean entryMatches(String key,
                            Collection<String> patterns)

getBlankEntryKey

public String getBlankEntryKey()

getCommentEntryKey

public String getCommentEntryKey()

executeRead

protected <T> T executeRead(Callable<T> callable)

executeWrite

protected <T> T executeWrite(Callable<T> callable)