- AbstractCategory - Class in de.vandermeer.skb.base.shell
-
Abstract category implementation, use the
SkbShellFactory to create a new object.
- AbstractCommandInterpreter - Class in de.vandermeer.skb.base.shell
-
An abstract command interpreter implementation with all basic features.
- AbstractCommandInterpreter() - Constructor for class AbstractCommandInterpreter
-
Returns a new, empty interpreter.
- AbstractCommandInterpreter(SkbShellCommand) - Constructor for class AbstractCommandInterpreter
-
Returns a new interpreter set for a single command.
- AbstractCommandInterpreter(SkbShellCommand[]) - Constructor for class AbstractCommandInterpreter
-
Returns a new interpreter set for an array of commands.
- AbstractCommandInterpreter(Collection<SkbShellCommand>) - Constructor for class AbstractCommandInterpreter
-
Returns a new interpreter set for a collection of commands.
- AbstractDirectoryInfo - Class in de.vandermeer.skb.base.info
-
An abstract directory info implementation that can be configured for use as source or target.
- AbstractDirectoryInfo(String) - Constructor for class AbstractDirectoryInfo
-
Creates a new directory info object from a directory name.
- AbstractDirectoryInfo(String, InfoLocationOptions) - Constructor for class AbstractDirectoryInfo
-
Creates a new directory info object from a directory name with options.
- AbstractDirectoryInfo.Options - Enum in de.vandermeer.skb.base.info
-
Options for an asString method
- AbstractFileInfo - Class in de.vandermeer.skb.base.info
-
An abstract file info implementation that can be configured for use as source or target.
- AbstractFileInfo(File, boolean) - Constructor for class AbstractFileInfo
-
Creates a new file info object from an existing File object with optional validation.
- AbstractFileInfo(File, String) - Constructor for class AbstractFileInfo
-
Creates a new file info object from an existing File object with a set-as-root directory.
- AbstractFileInfo(File) - Constructor for class AbstractFileInfo
-
Creates a new file info object from an existing File object.
- AbstractFileInfo(String) - Constructor for class AbstractFileInfo
-
Creates a new file info object from a file name.
- AbstractFileInfo(String, InfoLocationOptions) - Constructor for class AbstractFileInfo
-
Creates a new file info object from a file name with options.
- AbstractFileInfo(String, String) - Constructor for class AbstractFileInfo
-
Creates a new file info object from a path and a file name.
- AbstractFileInfo(String, String, InfoLocationOptions) - Constructor for class AbstractFileInfo
-
Creates a new file info object from a path and a file name with options.
- AbstractFileInfo.Options - Enum in de.vandermeer.skb.base.info
-
Options for an asString method
- AbstractLoader - Class in de.vandermeer.skb.base.info
-
Abstract loader implementation.
- AbstractLoader() - Constructor for class AbstractLoader
-
- AbstractShell - Class in de.vandermeer.skb.base.shell
-
An abstract shell implementation with all basic features, use the
SkbShellFactory or a sub-class to create a new object.
- AbstractShell() - Constructor for class AbstractShell
-
Returns a new shell with the default identifier and the default STG and console activated.
- AbstractShell(MessageRenderer) - Constructor for class AbstractShell
-
Returns a new shell with the default identifier and the given STG and console activated.
- AbstractShell(MessageRenderer, boolean) - Constructor for class AbstractShell
-
Returns a new shell with given STG and console flag.
- AbstractShell(String) - Constructor for class AbstractShell
-
Returns a new shell with a given identifier, standard STGroup and console activated.
- AbstractShell(String, boolean) - Constructor for class AbstractShell
-
Returns a new shell with given identifier and console flag with standard STGroup.
- AbstractShell(String, MessageRenderer) - Constructor for class AbstractShell
-
Returns a new shell with a given identifier and STGroup plus console activated.
- AbstractShell(String, MessageRenderer, boolean) - Constructor for class AbstractShell
-
Returns a new shell with given identifier and console flag.
- AbstractShellArgument - Class in de.vandermeer.skb.base.shell
-
An abstract, default implementation of a shell argument, use the
SkbShellFactory to create a new object.
- AbstractShellCommand - Class in de.vandermeer.skb.base.shell
-
An abstract, default implementation of a shell command, use the
SkbShellFactory to create a new object.
- AbstractSource - Class in de.vandermeer.skb.base.info
-
Abstract source implementation.
- AbstractSource() - Constructor for class AbstractSource
-
- AbstractTarget - Class in de.vandermeer.skb.base.info
-
Abstract target implementation.
- AbstractTarget() - Constructor for class AbstractTarget
-
- AbstractValidator - Class in de.vandermeer.skb.base.info
-
Abstract implementation of a validator as base class for validators.
- AbstractValidator() - Constructor for class AbstractValidator
-
- AbstractWriter - Class in de.vandermeer.skb.base.info
-
Abstract writer implementation.
- AbstractWriter() - Constructor for class AbstractWriter
-
- addCommandInterpreter(CommandInterpreter) - Method in interface SkbShell
-
Adds a new command interpreter to the shell.
- addCommandInterpreter(CommandInterpreter[]) - Method in interface SkbShell
-
Adds a new set command interpreters to the shell.
- addCommandInterpreter(Collection<CommandInterpreter>) - Method in interface SkbShell
-
Adds a new collection of command interpreters to the shell.
- addedHelp() - Method in class AbstractShellArgument
-
- addedHelp() - Method in class AbstractShellCommand
-
- addedHelp() - Method in interface SkbShellArgument
-
Returns additional text for an auto-generated help for the argument.
- addedHelp() - Method in interface SkbShellCommand
-
Returns additional text for an auto-generated help for the argument.
- addHow(Object...) - Method in class Message5WH_Builder
-
Adds to the How? part of the message.
- addWhat(Object...) - Method in class Message5WH_Builder
-
Adds to the What? part of the message.
- addWhy(Object...) - Method in class Message5WH_Builder
-
Adds to the Why? part of the message.
- appID - Variable in class MessageMgr
-
The identifier (or name) of the application using the message manager.
- appID - Variable in class MessageMgrBuilder
-
The identifier (or name) of the application using the message manager.
- ARG_DIRECTORY - Static variable in class Ci_ScRun
-
The argument for directory names.
- ARG_SCRIPT_INFO - Static variable in class Ci_ScRun
-
The argument for script file names for info.
- ARG_SCRIPT_RUN - Static variable in class Ci_ScRun
-
The argument for script file names for run.
- ARG_TIME - Static variable in class Ci_Wait
-
The argument for wait time.
- asFile() - Method in class AbstractDirectoryInfo
-
Returns the directory info object name as File object
- asFile() - Method in class AbstractFileInfo
-
Returns the file info object name as File object
- asString() - Method in class AbstractSource
-
- asString() - Method in class DirectorySource
-
- asString() - Method in class DirectoryTarget
-
- asString() - Method in class FileSource
-
- asString() - Method in class FileTarget
-
- asString() - Method in interface InfoSource
-
Returns a string representation of the source for messages.
- asString() - Method in interface InfoTarget
-
Returns a string representation of the target for messages.
- asStringOpt - Variable in class AbstractDirectoryInfo
-
Option for the return value of asString method.
- asStringOpt - Variable in class AbstractFileInfo
-
Option for the return value of asString method.
- asURL() - Method in class AbstractDirectoryInfo
-
Returns the directory info object name as URL object.
- asURL() - Method in class AbstractFileInfo
-
Returns the file info object name as URL object.
- changeType(E_MessageType) - Method in class Message5WH
-
Changes the type of the message.
- Ci_Exit - Class in de.vandermeer.skb.base.shell
-
An interpreter for the 'exit' shell command.
- Ci_Exit() - Constructor for class Ci_Exit
-
Returns an new 'exit' command interpreter.
- Ci_Help - Class in de.vandermeer.skb.base.shell
-
An abstract help command interpreter.
- Ci_Help(SkbShell) - Constructor for class Ci_Help
-
Returns an new 'help' command interpreter for STG output.
- Ci_HelpStg - Class in de.vandermeer.skb.base.shell
-
An interpreter for the 'help' shell command using an STG for output.
- Ci_HelpStg(SkbShell) - Constructor for class Ci_HelpStg
-
Returns an new 'help' command interpreter for STG output.
- Ci_HelpTable - Class in de.vandermeer.skb.base.shell
-
An interpreter for the 'help' shell command using an ASCII table for output.
- Ci_HelpTable(SkbShell) - Constructor for class Ci_HelpTable
-
Returns an new 'help' command interpreter for table output with default grid and columns set to width of 15 and 70.
- Ci_HelpTable(SkbShell, TA_Grid) - Constructor for class Ci_HelpTable
-
Returns an new 'help' command interpreter for table output.
- Ci_History - Class in de.vandermeer.skb.base.shell
-
An interpreter for the 'history' shell command.
- Ci_History(SkbShell) - Constructor for class Ci_History
-
Returns an new 'history' command interpreter.
- Ci_ScRun - Class in de.vandermeer.skb.base.shell
-
An interpreter for the 'run' shell command.
- Ci_ScRun(SkbShell) - Constructor for class Ci_ScRun
-
Returns an new 'run' command interpreter which will print progress information.
- Ci_ScRun(boolean, SkbShell) - Constructor for class Ci_ScRun
-
Returns an new 'run' command interpreter.
- Ci_Wait - Class in de.vandermeer.skb.base.shell
-
An interpreter for the 'wait' shell command.
- Ci_Wait() - Constructor for class Ci_Wait
-
Returns an new 'wait' command interpreter.
- clear() - Method in class SimpleDirectoryScanner
-
Clears errors and warnings, automatically called for new scans.
- clear() - Method in class MessageMgr
-
Resets the collected messages and all counters.
- CommandInterpreter - Interface in de.vandermeer.skb.base.shell
-
An interpreter for a shell command.
- commandMap - Variable in class AbstractShell
-
Mapping of a set of commands to an associated command interpreter.
- CommonsDirectoryWalker - Class in de.vandermeer.skb.base.info
-
Walks a directory and loads files.
- CommonsDirectoryWalker(DirectorySource, IOFileFilter, IOFileFilter) - Constructor for class CommonsDirectoryWalker
-
Returns a new loader that uses a directory walker with directory and file filters.
- CommonsDirectoryWalker(String, IOFileFilter, IOFileFilter) - Constructor for class CommonsDirectoryWalker
-
Returns a new loader that uses a directory walker with directory and file filters.
- createErrorMessage(String, Object...) - Static method in class MessageMgr
-
Creates a new error message.
- createFile(String) - Static method in class FileTarget
-
Creates a file for a given absolute file name (absolute path and file name).
- createInfoMessage(String, Object...) - Static method in class MessageMgr
-
Creates a new information message.
- createWarningMessage(String, Object...) - Static method in class MessageMgr
-
Creates a new warning message.
- cwc - Variable in class Ci_HelpTable
-
Table width calculated.
- de.vandermeer.skb.base - package de.vandermeer.skb.base
-
Base definitions and interfaces for the SKB.
- de.vandermeer.skb.base.console - package de.vandermeer.skb.base.console
-
Some utilities for console handling.
- de.vandermeer.skb.base.info - package de.vandermeer.skb.base.info
-
Interfaces and classes to load information from sources and to write information to targets.
- de.vandermeer.skb.base.managers - package de.vandermeer.skb.base.managers
-
Classes that manage other classes or artifacts, for instance a message manager.
- de.vandermeer.skb.base.message - package de.vandermeer.skb.base.message
-
Classes for a simple 5WH message object, for details on 5WH see
Wikipedia.
- de.vandermeer.skb.base.shell - package de.vandermeer.skb.base.shell
-
A shell with an abstract implementation, commands and arguments, and standard commands and arguments.
- de.vandermeer.skb.base.strings - package de.vandermeer.skb.base.strings
-
Some special strings for identifier/version and other combinations.
- de.vandermeer.skb.base.utils - package de.vandermeer.skb.base.utils
-
Standard utilities for the SKB.
- DEFAULT_STG - Static variable in class MessageRenderer
-
- DEFAULT_STG_FN - Static variable in class MessageRenderer
-
The file name of the default STGroup file.
- DIRECTORIES_ONLY - Static variable in class DirectorySource
-
A simple filter for directories.
- DirectoryLoader - Interface in de.vandermeer.skb.base.info
-
An directory information loader.
- DirectorySource - Class in de.vandermeer.skb.base.info
-
A source object for a directory.
- DirectorySource(String) - Constructor for class DirectorySource
-
Creates a new directory source object from a directory name.
- DirectorySource(String, InfoLocationOptions) - Constructor for class DirectorySource
-
Creates a new directory source object from a directory name with options.
- DirectoryTarget - Class in de.vandermeer.skb.base.info
-
A source object for a directory.
- DirectoryTarget(String) - Constructor for class DirectoryTarget
-
Creates a new directory target object from a directory name.
- DirectoryTarget(String, InfoLocationOptions) - Constructor for class DirectoryTarget
-
Creates a new directory target from a directory name with options.
- DirectoryValidator - Class in de.vandermeer.skb.base.info
-
An validator for a directory or path.
- DirectoryValidator(String, ValidationOptions) - Constructor for class DirectoryValidator
-
Returns a new directory validator.
- DirectoryValidator(File, ValidationOptions) - Constructor for class DirectoryValidator
-
Returns a new directory validator.
- doCollectMessages - Variable in class MessageMgr
-
Flag to define the behavior for message collection.
- doCollectMessages - Variable in class MessageMgrBuilder
-
Flag to define the behavior for message collection.
- doScan(File) - Method in class SimpleDirectoryScanner
-
Does the actual scan of a directory.
- FigletShutdown - Enum in de.vandermeer.skb.base.utils
-
Collection of FigLets for funny shutdown messages.
- file - Variable in class AbstractDirectoryInfo
-
The underlying file object for the directory.
- file - Variable in class AbstractFileInfo
-
The underlying file object for the file name.
- FileLoader - Interface in de.vandermeer.skb.base.info
-
An file information loader.
- FILES_ONLY - Static variable in class FileSource
-
A simple filter for files.
- FileSource - Class in de.vandermeer.skb.base.info
-
File source for an information source.
- FileSource(File, boolean) - Constructor for class FileSource
-
Creates a new file source from an existing File object with optional validation.
- FileSource(File, String) - Constructor for class FileSource
-
Creates a new file source object from an existing File object with a set-as-root directory.
- FileSource(File) - Constructor for class FileSource
-
Creates a new file source from an existing File object.
- FileSource(String) - Constructor for class FileSource
-
Creates a new file source from a file name.
- FileSource(String, InfoLocationOptions) - Constructor for class FileSource
-
Creates a new file source from a file name with options.
- FileSource(String, String) - Constructor for class FileSource
-
Creates a new file source from a path and a file name.
- FileSource(String, String, InfoLocationOptions) - Constructor for class FileSource
-
Creates a new file source from a path and a file name with options.
- FileSourceList - Class in de.vandermeer.skb.base.info
-
A source object for an array of File objects.
- FileSourceList(List<FileSource>) - Constructor for class FileSourceList
-
Returns a new source for an array of
FileSource objects.
- FileSourceListLoader - Interface in de.vandermeer.skb.base.info
-
An file set information loader.
- FileTarget - Class in de.vandermeer.skb.base.info
-
File target for an information target.
- FileTarget(File, boolean) - Constructor for class FileTarget
-
Creates a new file target from an existing File object with optional validation.
- FileTarget(File) - Constructor for class FileTarget
-
Creates a new file target from an existing File object.
- FileTarget(File, String) - Constructor for class FileTarget
-
Creates a new file target object from an existing File object with a set-as-root directory.
- FileTarget(String) - Constructor for class FileTarget
-
Creates a new file target from a file name.
- FileTarget(String, InfoLocationOptions) - Constructor for class FileTarget
-
Creates a new file target from a file name with options.
- FileTarget(String, String) - Constructor for class FileTarget
-
Creates a new file target from a path and a file name.
- FileTarget(String, String, InfoLocationOptions) - Constructor for class FileTarget
-
Creates a new file target from a path and a file name with options.
- FileValidator - Class in de.vandermeer.skb.base.info
-
An validator for a file.
- FileValidator(String, ValidationOptions) - Constructor for class FileValidator
-
Returns a new file validator.
- FileValidator(File, ValidationOptions) - Constructor for class FileValidator
-
Returns a new file validator.
- FileWriter - Interface in de.vandermeer.skb.base.info
-
An file information writer.
- generalHelp(IsInfoSetFT) - Method in class Ci_HelpStg
-
Processes general help with no specific command requested.
- generalHelp(AsciiTable) - Method in class Ci_HelpTable
-
Processes general help with no specific command requested.
- GET_STG_NAME(STGroup) - Static method in class STGroupValidator
-
Returns the name of the STGroup.
- getAbsoluteName() - Method in class AbstractFileInfo
-
Returns the absolute name of the file with all path information and the file (with extension).
- getAbsolutePath() - Method in class AbstractFileInfo
-
Returns the absolute path of the file, without the file name
- getArgList() - Method in class LineParser
-
Returns a list of all tokens that can be considered being command arguments, using the current token position.
- getArgMap() - Method in class LineParser
-
Returns a map of all tokens that can be considered being command arguments, using the current token position.
- getArgMap(SkbShellArgument[]) - Method in class LineParser
-
Returns an argument map fitting the given value key set (using defined types).
- getArgs() - Method in class LineParser
-
Returns an string of all tokens that can be considered being command arguments, using the current token position.
- getArguments() - Method in class AbstractShellCommand
-
- getArguments() - Method in interface SkbShellCommand
-
Returns the arguments of this command.
- getBaseFileName() - Method in class AbstractFileInfo
-
Returns the base name of the file name of the object.
- getBuildErrors() - Method in class MessageMgrBuilder
-
Returns errors the builder collected.
- getCallWTimeout(BufferedReader, HasPrompt) - Static method in class NonBlockingReader
-
Returns a new callable for reading strings from a reader with a set timeout of 200ms.
- getCallWTimeout(BufferedReader, int, HasPrompt) - Static method in class NonBlockingReader
-
Returns a new callable for reading strings from a reader with a given timeout.
- getCategory() - Method in class AbstractCategory
-
- getCategory() - Method in class AbstractShellCommand
-
- getCategory() - Method in interface SkbShellCommand
-
Returns a category the command belongs to, useful for grouping commands for example in help screens.
- getCategory() - Method in interface SkbShellCommandCategory
-
Returns the category.
- getCommand() - Method in class AbstractShellCommand
-
- getCommand() - Method in interface SkbShellCommand
-
Returns the shell command.
- getCommandHistory() - Method in class AbstractShell
-
- getCommandHistory() - Method in interface SkbShell
-
Returns the command history of the shell, that is the last n commands (n depends on implementation).
- getCommandMap() - Method in class AbstractShell
-
- getCommandMap() - Method in interface SkbShell
-
Returns the shell's mapping of commands to associated command interpreters.
- getCommands() - Method in class AbstractCommandInterpreter
-
- getCommands() - Method in class AbstractShell
-
- getCommands() - Method in interface CommandInterpreter
-
Returns the mapping of commands to
SkbShellCommand this interpreter does handle.
- getCommands() - Method in interface SkbShell
-
Returns all commands set for the shell.
- getCommandStrings() - Method in class AbstractCommandInterpreter
-
- getCommandStrings() - Method in interface CommandInterpreter
-
Returns the set of commands this interpreter does handle.
- getContent(String, MessageMgr) - Method in class Ci_ScRun
-
Returns the content of a string read from a file.
- getDescription() - Method in class AbstractCategory
-
- getDescription() - Method in class AbstractShellArgument
-
- getDescription() - Method in class AbstractShellCommand
-
- getDescription() - Method in interface SkbShell
-
Returns the description of the shell.
- getDescription() - Method in enum SkbShellArgumentType
-
- getDescription() - Method in interface SkbShellCommandCategory
-
- getDisplayName() - Method in interface SkbShell
-
Returns the display name of the shell.
- getExitStatus() - Method in class AbstractShell
-
- getExitStatus() - Method in interface SkbShell
-
Returns the exit status of the shell.
- getFileExtension() - Method in class AbstractFileInfo
-
Returns the file extension of the file name, without the leading dot.
- getFileName(LineParser) - Method in class Ci_ScRun
-
Returns a file name taken as argument from the line parser with fixed extension
- getFiles() - Method in class SimpleDirectoryScanner
-
Returns a set of files found in the given directory.
- getFullDirecoryName() - Method in class AbstractDirectoryInfo
-
Returns the full directory name.
- getFullFileName() - Method in class AbstractFileInfo
-
Returns the full file name (base name plus dot plus extension).
- getHow() - Method in class Message5WH
-
Returns the How? part of the message.
- getID() - Method in class AbstractShell
-
- getID() - Method in interface SkbShell
-
Returns the identifier of the shell.
- getID() - Method in class IdVersionString
-
Returns the identifier part of the string
- getID() - Method in class IdVersionValueString
-
Returns the identifier part of the string
- getInfo() - Method in class DirectoryValidator
-
- getInfo() - Method in class FileValidator
-
- getInfo() - Method in interface InfoValidator
-
Returns the information object that is validated.
- getInfo() - Method in class STGroupValidator
-
- getInfo() - Method in class STValidator
-
- getInitError() - Method in class AbstractSource
-
- getInitError() - Method in class AbstractTarget
-
- getInitError() - Method in class DirectorySource
-
- getInitError() - Method in class DirectoryTarget
-
- getInitError() - Method in class FileSource
-
- getInitError() - Method in class FileTarget
-
- getInitError() - Method in interface InfoSource
-
Returns any error that happened during initialization (and relate validation) of the source.
- getInitError() - Method in interface InfoTarget
-
Returns any error that happened during initialization (and relate validation) of the target.
- getKey() - Method in class AbstractShellArgument
-
- getKey() - Method in interface SkbShellArgument
-
Returns the key of a shell argument.
- getLine() - Method in class LineParser
-
Returns the original command line.
- getLines() - Method in enum FigletShutdown
-
Returns an array with all defined FigLets lines for one font.
- getLoadErrors() - Method in class AbstractLoader
-
- getLoadErrors() - Method in class CommonsDirectoryWalker
-
- getLoadErrors() - Method in interface InfoLoader
-
Returns collected errors from the last invocation of load or other methods.
- getMajor() - Method in class VersionString
-
Returns the major part of the version.
- getMessageCollection() - Method in class MessageMgr
-
Returns the collected messages.
- getMessageCount(E_MessageType) - Method in class MessageMgr
-
Returns the current count for the given message type since its last initialization or reset.
- getMessageManager() - Method in class AbstractShell
-
- getMessageManager() - Method in interface SkbShell
-
Returns the shell's message manager.
- getMessageMap() - Method in class MessageMgr
-
Returns the collected messages.
- getMinor() - Method in class VersionString
-
Returns the minor part of the version.
- getNbReader(String, int, int, HasPrompt) - Static method in class NonBlockingReader
-
Returns a new BufferedReader that uses tries and timeout for readline() for a UTF-8 StdIn.
- getNbReader(BufferedReader, int, int, HasPrompt) - Static method in class NonBlockingReader
-
Returns a new BufferedReader that uses tries and timeout for readline().
- getOriginal() - Method in class DirectoryValidator
-
- getOriginal() - Method in class FileValidator
-
- getOriginal() - Method in interface InfoValidator
-
Returns the original object used to create the validation object.
- getOriginal() - Method in class STGroupValidator
-
- getOriginal() - Method in class STValidator
-
- getPatch() - Method in class VersionString
-
Returns the patch part of the version.
- getPromptName() - Method in interface SkbShell
-
Returns the prompt name of the shell.
- getReporter() - Method in class Message5WH
-
Returns the reporter of the message
- getRootPath() - Method in class AbstractFileInfo
-
Returns the root path which is either the absolute path or (if any directory is set and
AbstractFileInfo.getSetRootPath() returns not null) the path to the set-as-root path
- getSetRootName() - Method in class AbstractFileInfo
-
Returns the path and file elements for the set-as-root path of the file if a directory was explicitly given to one of the constructors.
- getSetRootPath() - Method in class AbstractDirectoryInfo
-
Returns a path set-as-root to the directory.
- getSetRootPath() - Method in class AbstractFileInfo
-
Returns a path set-as-root to the file if a directory was explicitly given to one of the constructors.
- getSource() - Method in class AbstractSource
-
- getSource() - Method in class CommonsDirectoryWalker
-
- getSource() - Method in interface DirectoryLoader
-
- getSource() - Method in class DirectorySource
-
- getSource() - Method in class DirectoryTarget
-
- getSource() - Method in interface FileLoader
-
- getSource() - Method in class FileSource
-
- getSource() - Method in class FileSourceList
-
- getSource() - Method in interface FileSourceListLoader
-
- getSource() - Method in interface InfoLoader
-
Returns the source set for the loader, that is where the loader loads information from.
- getSource() - Method in interface InfoSource
-
Returns the actual source.
- getSource() - Method in class JsonFileLoader
-
- getSource() - Method in class PropertyArrayLoader
-
- getSource() - Method in class PropertyFileLoader
-
- getSource() - Method in class SimpleDirectoryScanner
-
- getSource() - Method in class StgFileLoader
-
- getSource() - Method in class StringFileLoader
-
- getSourceAsArray() - Method in class FileSourceList
-
Returns file list as a array.
- getSourceAsFileArray() - Method in class FileSourceList
-
Returns file list as an array of File objects.
- getSourceAsFileSourceList() - Method in class FileSourceList
-
Returns file list as a list of File objects.
- getTarget() - Method in class AbstractTarget
-
- getTarget() - Method in class FileTarget
-
- getTarget() - Method in interface FileWriter
-
- getTarget() - Method in interface InfoTarget
-
Returns the actual target.
- getTarget() - Method in interface InfoWriter
-
Returns the target set for the writer, that is where the writer writes information to.
- getTarget() - Method in class StringFileWriter
-
- getToken() - Method in class LineParser
-
Returns an array of all tokens being parsed.
- getType() - Method in class Message5WH
-
Returns the type of the message.
- getType() - Method in class AbstractShellArgument
-
- getType() - Method in interface SkbShellArgument
-
Returns the type of a shell argument.
- getValidationErrors() - Method in class AbstractValidator
-
- getValidationErrors() - Method in interface InfoValidator
-
Returns collected errors from the last invocation of load or other methods.
- getValue() - Method in class IdVersionValueString
-
Returns the value part of the string.
- getVersion() - Method in class IdVersionString
-
Returns the version part of the string.
- getVersion() - Method in class IdVersionValueString
-
Returns the version part of the string.
- getWhat() - Method in class Message5WH
-
Returns the What? part of the message.
- getWhen() - Method in class Message5WH
-
Returns the When? part of the message.
- getWhereColumn() - Method in class Message5WH
-
Returns the Where? column part of the message.
- getWhereLine() - Method in class Message5WH
-
Returns the Where? line part of the message.
- getWhereLocation() - Method in class Message5WH
-
Returns the Where? location part of the message.
- getWho() - Method in class Message5WH
-
Returns the Who? part of the message.
- getWhy() - Method in class Message5WH
-
Returns the Why? part of the message.
- getWriteErrors() - Method in class AbstractWriter
-
- getWriteErrors() - Method in interface InfoWriter
-
Returns collected errors from the last invocation of write or other methods.
- grid - Variable in class Ci_HelpTable
-
The grid for the table.
- id - Variable in class AbstractShell
-
The shell's identifier.
- id - Variable in class IdVersionString
-
Identifier part of the string.
- id - Variable in class IdVersionValueString
-
Identifier and version part of the string.
- IdVersionString - Class in de.vandermeer.skb.base.strings
-
Class handling a string as a combination of an identifier and a version part.
- IdVersionString(String) - Constructor for class IdVersionString
-
Returns a new id/version combined string.
- IdVersionString(String, String) - Constructor for class IdVersionString
-
Returns a new id/version combined string.
- IdVersionStringRenderer - Class in de.vandermeer.skb.base.strings
-
- IdVersionStringRenderer() - Constructor for class IdVersionStringRenderer
-
- IdVersionValueString - Class in de.vandermeer.skb.base.strings
-
Class handling a string as a combination of an identifier, a version and a value part.
- IdVersionValueString(String) - Constructor for class IdVersionValueString
-
Returns a new id/version/value combined string.
- InfoLoader - Interface in de.vandermeer.skb.base.info
-
An information source loader.
- InfoLocationOptions - Enum in de.vandermeer.skb.base.info
-
Options to locate information.
- InfoSource - Interface in de.vandermeer.skb.base.info
-
A source of information.
- InfoTarget - Interface in de.vandermeer.skb.base.info
-
An information target.
- InfoValidator - Interface in de.vandermeer.skb.base.info
-
An information validator.
- InfoWriter - Interface in de.vandermeer.skb.base.info
-
An information writer.
- init(String, InfoLocationOptions) - Method in class AbstractDirectoryInfo
-
Initialize the directory info object with any parameters presented by the constructors.
- init(File, String, String, InfoLocationOptions) - Method in class AbstractFileInfo
-
Initialize the file info object with any parameters presented by the constructors.
- init(File, String, String, InfoLocationOptions) - Method in class StgFileSource
-
Initialize the file source with any parameters presented by the constructors.
- initialCapacity - Variable in class Message5WH_Builder
-
Initial capacity for StrBuilder members
- interpretCommand(String, LineParser, MessageMgr) - Method in class Ci_Exit
-
- interpretCommand(String, LineParser, MessageMgr) - Method in class Ci_Help
-
- interpretCommand(String, LineParser, MessageMgr) - Method in class Ci_HelpStg
-
- interpretCommand(String, LineParser, MessageMgr) - Method in class Ci_HelpTable
-
- interpretCommand(String, LineParser, MessageMgr) - Method in class Ci_History
-
- interpretCommand(String, LineParser, MessageMgr) - Method in class Ci_ScRun
-
- interpretCommand(String, LineParser, MessageMgr) - Method in class Ci_Wait
-
- interpretCommand(String, LineParser, MessageMgr) - Method in interface CommandInterpreter
-
Interprets the given command.
- interpretInfo(LineParser, MessageMgr) - Method in class Ci_ScRun
-
Interprets the actual info command
- interpretLs(LineParser, MessageMgr) - Method in class Ci_ScRun
-
Interprets the actual ls command
- interpretRun(LineParser, MessageMgr) - Method in class Ci_ScRun
-
Interprets the actual run command
- isEnabledFor(E_MessageType) - Method in class MessageMgr
-
Returns is the report level is enabled or not.
- isOptional() - Method in class AbstractShellArgument
-
- isOptional() - Method in interface SkbShellArgument
-
Optional flag for the argument.
- isRunning - Variable in class AbstractShell
-
Flag indicating if the shell is running.
- isRunning() - Method in class AbstractShell
-
- isRunning() - Method in interface SkbShell
-
tests if the shell is running.
- isValid() - Method in class AbstractDirectoryInfo
-
Flag reporting on the validation.
- isValid() - Method in class AbstractFileInfo
-
Flag reporting on the validation.
- isValid() - Method in interface InfoSource
-
Returns the valid flag of the source.
- isValid() - Method in interface InfoTarget
-
Returns the valid flag of the target.
- isValid() - Method in interface InfoValidator
-
Flag reporting on the validation.
- sameAs(Object) - Method in class IdVersionString
-
Tests if the parameter is the same id and version.
- SC_INFO - Static variable in class Ci_ScRun
-
The command for info on scripts.
- SC_LS - Static variable in class Ci_ScRun
-
The command for ls on scripts.
- SC_RUN - Static variable in class Ci_ScRun
-
The command for running scripts.
- SCRIPT_FILE_EXTENSION - Static variable in class Ci_ScRun
-
Extension for script files.
- separator - Variable in class VersionString
-
Separator character for toString.
- setAsStringOption(AbstractDirectoryInfo.Options) - Method in class AbstractDirectoryInfo
-
Sets the option for an asString method
- setAsStringOption(AbstractFileInfo.Options) - Method in class AbstractFileInfo
-
Sets the option for an asString method
- setHandler(E_MessageType) - Method in class MessageMgrBuilder
-
Activate a message type and sets a type handler with max count set to 100.
- setHandler(E_MessageType, int) - Method in class MessageMgrBuilder
-
Activate a message type and sets a type handler with max count.
- setHandler(E_MessageType, Logger) - Method in class MessageMgrBuilder
-
Activate a message type and sets a type handler with max count set to 100 using specific logger.
- setHandler(E_MessageType, int, Logger) - Method in class MessageMgrBuilder
-
Activate a message type and sets a type handler with max count using specific logger.
- setRenderer(MessageRenderer) - Method in class MessageMgr
-
Sets an renderer for the object, which then will be used to render all messages.
- setReporter(Object) - Method in class Message5WH
-
Sets the reporter.
- setReporter(Object) - Method in class Message5WH_Builder
-
Sets the Reporter of the message.
- setSeparator(char) - Method in class VersionString
-
- setTokenPosition(int) - Method in class LineParser
-
Sets the parsers position in the token stream.
- setType(E_MessageType) - Method in class Message5WH_Builder
-
Sets the type of the message.
- setWhen(Object) - Method in class Message5WH_Builder
-
Sets the When? part of the message.
- setWhere(Object, int, int) - Method in class Message5WH_Builder
-
Sets the Where? part of the message.
- setWhere(Object, RecognitionException) - Method in class Message5WH_Builder
-
Sets the Where? part of the message.
- setWhere(Object) - Method in class Message5WH_Builder
-
Sets the Where? part of the message.
- setWhere(Object, Token) - Method in class Message5WH_Builder
-
Sets the Where? part of the message.
- setWhere(Object, ParserRuleContext) - Method in class Message5WH_Builder
-
Sets the Where? part of the message.
- setWhere(StackTraceElement) - Method in class Message5WH_Builder
-
Sets the Where? part of the message.
- setWho(Object) - Method in class Message5WH_Builder
-
Sets the Who? part of the message.
- setWidth(AT_ColumnWidthCalculator) - Method in class Ci_HelpTable
-
Sets the table with.
- SIMPLE_COMMANDS - Static variable in class SkbShellFactory
-
A category for standard commands.
- SimpleDirectoryScanner - Class in de.vandermeer.skb.base.info
-
Scans a directory and returns a complete list of files found.
- SimpleDirectoryScanner(DirectorySource) - Constructor for class SimpleDirectoryScanner
-
Returns a new directory scanner for a given source.
- Skb_BaseException - Exception in de.vandermeer.skb.base
-
Default SKB exception.
- Skb_BaseException() - Constructor for exception Skb_BaseException
-
Returns a new exception
- Skb_BaseException(Throwable) - Constructor for exception Skb_BaseException
-
Returns a new exception with given cause
- Skb_BaseException(String, String) - Constructor for exception Skb_BaseException
-
Returns a new exception with given cause and message
- Skb_Defaults - Class in de.vandermeer.skb.base
-
Some default definitions for the SKB.
- Skb_Defaults() - Constructor for class Skb_Defaults
-
- skbsh - Variable in class Ci_History
-
Link to the calling shell to retrieve history from.
- skbShell - Variable in class Ci_Help
-
The calling shell, needed to parse lines.
- skbShell - Variable in class Ci_ScRun
-
The calling shell, needed to parse lines.
- SkbShell - Interface in de.vandermeer.skb.base.shell
-
A shell with flexible adding of commands and auto-generation of help and other commands.
- SkbShellArgument - Interface in de.vandermeer.skb.base.shell
-
An argument for a command for the
SkbShell.
- SkbShellArgumentType - Enum in de.vandermeer.skb.base.shell
-
- SkbShellCommand - Interface in de.vandermeer.skb.base.shell
-
- SkbShellCommandCategory - Interface in de.vandermeer.skb.base.shell
-
Category of a shell command.
- SkbShellFactory - Class in de.vandermeer.skb.base.shell
-
Factory for Skb Shell artifacts.
- SkbShellFactory() - Constructor for class SkbShellFactory
-
- specificHelp(IsInfoSetFT, String) - Method in class Ci_HelpStg
-
Processes general help with no specific command requested.
- specificHelp(AsciiTable, String) - Method in class Ci_HelpTable
-
Processes general help with no specific command requested.
- start(Object) - Method in class AbstractShell
-
- start(Object) - Method in interface SkbShell
-
Starts the shell as a new thread.
- stg - Variable in class MessageRenderer
-
The ST group for the message
- STG_CHUNKS - Static variable in class MessageRenderer
-
The STGroup chunks for validation of an STGroup for a message.
- StgFileLoader - Class in de.vandermeer.skb.base.info
-
An file loader for STG property files.
- StgFileLoader(String) - Constructor for class StgFileLoader
-
Returns a new loader for a file name, creating a file source automatically.
- StgFileSource - Class in de.vandermeer.skb.base.info
-
File source for an STG file, the same as
FileSource plus extension check for "stg" extension.
- StgFileSource(File, boolean) - Constructor for class StgFileSource
-
Creates a new file source from an existing File object with optional validation.
- StgFileSource(File) - Constructor for class StgFileSource
-
Creates a new file source from an existing File object.
- StgFileSource(String) - Constructor for class StgFileSource
-
Creates a new file source from a file name.
- StgFileSource(String, InfoLocationOptions) - Constructor for class StgFileSource
-
Creates a new file source from a file name with options.
- StgFileSource(String, String) - Constructor for class StgFileSource
-
Creates a new file source from a path and a file name.
- StgFileSource(String, String, InfoLocationOptions) - Constructor for class StgFileSource
-
Creates a new file source from a path and a file name with options.
- STGroupValidator - Class in de.vandermeer.skb.base.info
-
An validator for an STGroup file.
- STGroupValidator(STGroup, Map<String, Set<String>>) - Constructor for class STGroupValidator
-
Returns a new STGroup validator.
- stop() - Method in class AbstractShell
-
- stop() - Method in interface SkbShell
-
Stops the shell thread.
- StringFileLoader - Class in de.vandermeer.skb.base.info
-
An file loader for reading a file into a string.
- StringFileLoader(FileSource) - Constructor for class StringFileLoader
-
Returns a new loader for a file source.
- StringFileLoader(String) - Constructor for class StringFileLoader
-
Returns a new loader for a file name, creating a file source automatically.
- StringFileWriter - Class in de.vandermeer.skb.base.info
-
An file information writer writing strings into a file.
- StringFileWriter(FileTarget) - Constructor for class StringFileWriter
-
Returns a new writer for a file target.
- StringFileWriter(String) - Constructor for class StringFileWriter
-
Returns a new writer for a file name, creating a file target automatically.
- STValidator - Class in de.vandermeer.skb.base.info
-
An validator for an ST file.
- STValidator(ST, Set<String>) - Constructor for class STValidator
-
Returns a new ST validator.
- validate(File, ValidationOptions) - Method in class DirectoryValidator
-
Does the actual validation
- validate(File, ValidationOptions) - Method in class FileValidator
-
Does the actual validation.
- validate(STGroup, Map<String, Set<String>>) - Method in class STGroupValidator
-
Does the actual validation of the STGroup.
- validate(ST, Set<String>) - Method in class STValidator
-
Validates the ST object and marks all missing arguments.
- validateSource() - Method in interface InfoLoader
-
Validates the loaders source.
- validateSTG() - Method in class MessageRenderer
-
Validates the local STGroup
- validateTarget() - Method in interface InfoWriter
-
Validates the writers target.
- ValidationOptions - Enum in de.vandermeer.skb.base.info
-
Options to validate sources and targets.
- valOption() - Method in class AbstractDirectoryInfo
-
Returns the validation option which makes this abstract implementation a info object or target or both.
- valOption() - Method in class AbstractFileInfo
-
Returns the validation option which makes this abstract implementation a info object or target or both.
- valOption() - Method in class DirectorySource
-
- valOption() - Method in class DirectoryTarget
-
- valOption() - Method in class FileSource
-
- valOption() - Method in class FileTarget
-
- value - Variable in class IdVersionValueString
-
Value part of the string.
- valueOf(String) - Static method in enum AbstractDirectoryInfo.Options
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum AbstractFileInfo.Options
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum InfoLocationOptions
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum ValidationOptions
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum E_MessageType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum SkbShellArgumentType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum FigletShutdown
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum AbstractDirectoryInfo.Options
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum AbstractFileInfo.Options
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum InfoLocationOptions
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum ValidationOptions
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum E_MessageType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum SkbShellArgumentType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum FigletShutdown
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- valueSet() - Method in class AbstractShellArgument
-
- valueSet() - Method in interface SkbShellArgument
-
- version - Variable in class IdVersionString
-
- VersionString - Class in de.vandermeer.skb.base.strings
-
A class for parsing a version string with major, minor and patch elements.
- VersionString(String) - Constructor for class VersionString
-
Creates a new version object from a string.
- VersionString(int, int, int) - Constructor for class VersionString
-
Creates a new version string from integer values.
- VersionStringRenderer - Class in de.vandermeer.skb.base.strings
-
- VersionStringRenderer() - Constructor for class VersionStringRenderer
-