com.sshtools.config.file.entry

Class Entry.AbstractEntryBuilder<T>

java.lang.Object

com.sshtools.config.file.entry.Entry.AbstractEntryBuilder<T>

Direct Known Subclasses:

MatchEntry.MatchEntryBuilder, SshdConfigFile.SshdConfigFileBuilder

Enclosing class:

Entry

public abstract static class Entry.AbstractEntryBuilder<T>
extends Object

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected SshdConfigFileCursor	cursor
protected SshdConfigFile	file
protected int	pointer

Constructor Summary

Constructors

Constructor and Description
AbstractEntryBuilder()

Method Summary

Modifier and Type	Method and Description
T	addBeginingComment(FileEntryType.CommentEntry commentEntry) Will add a comment entry at the beginning of the section.
T	addComment(String comment) Will add a comment entry at current location.
T	addCommentForEntry(String key, FileEntryType.CommentEntry commentEntry) Will add a comment entry before the entry with the given key.
T	addCommentForEntry(String key, String comment) Will add a comment entry before the entry with the given key.
T	addEntry(FileEntryType.SshdConfigFileEntry sshdConfigFileEntry) Will add entry after last non blank, non comment entry in a section (Global, Match) Note: Use while operating on file after loading it.
T	appendEntry(FileEntryType.SshdConfigFileEntry sshdConfigFileEntry) Will add entry to the end of section.
SshdConfigFileCursor	cursor()
T	deleteEntry(String key) Will delete the entry for the given key.
Boolean	entryMatches(String key, Collection<String> patterns)
T	entryMatches(String key, Collection<String> patterns, Entry.AbstractEntryBuilder.Result<Boolean> result)
FileEntryType.SshdConfigFileEntry	findEntry(String key)
T	findEntry(String key, Entry.AbstractEntryBuilder.Result<FileEntryType.SshdConfigKeyValueEntry> result)
FileEntryType.SshdConfigFileEntry	findEntryAtIndex(int index)
int	findEntryIndex(String key)
T	findEntryIndex(String key, Entry.AbstractEntryBuilder.Result<Integer> result)
T	findEntryToEdit(String key)
protected abstract Entry	getManagedInstance()
T	resetPointer()
T	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

cursor

protected SshdConfigFileCursor cursor

pointer

protected int pointer

file

protected SshdConfigFile file

Constructor Detail

AbstractEntryBuilder

public AbstractEntryBuilder()

Method Detail

getManagedInstance

protected abstract Entry getManagedInstance()

updateEntry

public T updateEntry(String key,
                     String value)

Will update the value for the given key with new entry.

Parameters:

key -

entry -

Returns:

deleteEntry

public T deleteEntry(String key)

Will delete the entry for the given key.

Parameters:

key -

Returns:

addComment

public T addComment(String comment)

Will add a comment entry at current location.

Parameters:

commentEntry -

Returns:

addCommentForEntry

public T addCommentForEntry(String key,
                            String comment)

Will add a comment entry before the entry with the given key. Note: Multiple calls will add calls in reverse.

        addCommentForEntry(....1)
  addCommentForEntry(....2)
  addCommentForEntry(....3)
 

Above will end up as first 3, then 2 finally 1. All entries are made at index at which the entry is found.

Parameters:

comment -

addCommentForEntry

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

Will add a comment entry before the entry with the given key. Note: Multiple calls will add calls in reverse.

        addCommentForEntry(....1)
  addCommentForEntry(....2)
  addCommentForEntry(....3)
 

Above will end up as first 3, then 2 finally 1. All entries are made at index at which the entry is found.

Parameters:

commentEntry -

addBeginingComment

public T addBeginingComment(FileEntryType.CommentEntry commentEntry)

Will add a comment entry at the beginning of the section. Note: Multiple calls will add calls in reverse.

        addBeginingComment(....1)
  addBeginingComment(....2)
  addBeginingComment(....3)
 

Above will end up as first 3, then 2 finally 1. All entries are made at index 0.

Parameters:

commentEntry -

addEntry

public T addEntry(FileEntryType.SshdConfigFileEntry sshdConfigFileEntry)

Will add entry after last non blank, non comment entry in a section (Global, Match) Note: Use while operating on file after loading it.

Parameters:

sshdConfigFileEntry -

Returns:

appendEntry

public T appendEntry(FileEntryType.SshdConfigFileEntry sshdConfigFileEntry)

Will add entry to the end of section. Note: Use while writing a file.

Parameters:

sshdConfigFileEntry -

Returns:

findEntry

public FileEntryType.SshdConfigFileEntry findEntry(String key)

findEntry

public T findEntry(String key,
                   Entry.AbstractEntryBuilder.Result<FileEntryType.SshdConfigKeyValueEntry> result)

entryMatches

public T entryMatches(String key,
                      Collection<String> patterns,
                      Entry.AbstractEntryBuilder.Result<Boolean> result)

entryMatches

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

findEntryIndex

public int findEntryIndex(String key)

findEntryAtIndex

public FileEntryType.SshdConfigFileEntry findEntryAtIndex(int index)

findEntryIndex

public T findEntryIndex(String key,
                        Entry.AbstractEntryBuilder.Result<Integer> result)

findEntryToEdit

public T findEntryToEdit(String key)

resetPointer

public T resetPointer()

cursor

public SshdConfigFileCursor cursor()