A B C D E F G H I L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- absoluteFilePath - Variable in class echo.util.FindFileInAbsolutePath
- absoluteFilePath - Variable in class echo.util.FindFileInClassPath
- append - Variable in class echo.EchoMojo
-
If the message should be appended to the toFile instead of opening a new file/overwrite an existing file
- append(StringBuilder, String, int) - Method in class echo.HelpMojo
-
Append a description to the buffer by respecting the indentSize and lineLength parameters.
- appendOneCharOutput(char) - Method in class echo.CharacterOutput
- appendToFile - Variable in class echo.parameter.PluginParameters
- appendToFile - Variable in class echo.parameter.PluginParametersBuilder
- appendToFile - Variable in class echo.util.FileUtil
B
- basePath - Variable in class echo.EchoMojo
-
The default path for fromFile and toFile.
- basePath - Variable in class echo.parameter.PluginParameters
- basePath - Variable in class echo.parameter.PluginParametersBuilder
- basePath - Variable in class echo.util.FileUtil
- build() - Method in class echo.HelpMojo
C
- characterOutput - Variable in class echo.EchoMojo
-
Debug flag that outputs the message as a character list
- characterOutput - Variable in class echo.EchoPlugin
- characterOutput - Variable in class echo.parameter.PluginParameters
- characterOutput - Variable in class echo.parameter.PluginParametersBuilder
- CharacterOutput - Class in echo
-
Converts the message content as a user-friendly character string
- CharacterOutput(PluginParameters) - Constructor for class echo.CharacterOutput
-
Create a new instance of the CharacterOutput class
- checkForNonWritableFile(File) - Method in class echo.util.FileUtil
- checkLineSeparator() - Method in class echo.parameter.LineSeparator
- checkMissingMessage() - Method in class echo.MessageExtractor
- createPluginParameters() - Method in class echo.parameter.PluginParametersBuilder
-
Builds the PluginParameters instance
D
- debug(String) - Method in interface echo.output.EchoOutput
-
The message will be output with debug level (maven debugging must be turned on to see message)
- debug(String) - Method in class echo.output.MavenEchoOutput
- debug(String) - Method in class echo.output.MavenPluginLog
- debug(String) - Method in interface echo.output.PluginLog
-
Log the content to the debug level.
- debug(Throwable) - Method in class echo.output.MavenPluginLog
- debug(Throwable) - Method in interface echo.output.PluginLog
-
Log the throwable to the debug level.
- DEBUG - echo.parameter.OutputLevelType
- DEFAULT_LINE_LENGTH - Static variable in class echo.HelpMojo
- detail - Variable in class echo.HelpMojo
-
If
true
, display all settable properties for each goal.
E
- echo - package echo
- echo() - Method in class echo.EchoMojo
- echo() - Method in class echo.EchoPlugin
-
Output the message
- echo.exception - package echo.exception
- echo.output - package echo.output
- echo.parameter - package echo.parameter
- echo.util - package echo.util
- EchoMojo - Class in echo
-
Mojo (Maven plugin) that outputs messages during Maven build.
- EchoMojo() - Constructor for class echo.EchoMojo
- echoOutput - Variable in class echo.EchoMojo
- echoOutput - Variable in class echo.EchoPlugin
- echoOutput - Variable in class echo.output.EchoOutputWrapper
- EchoOutput - Interface in echo.output
-
Output a message to standard output with a specific level
- EchoOutputWrapper - Class in echo.output
-
Will echo a message to standard output (in Maven) with the right message level.
- EchoOutputWrapper(EchoOutput, PluginParameters) - Constructor for class echo.output.EchoOutputWrapper
-
Creates a new instance of the EchoOutputWrapper class
- echoPlugin - Variable in class echo.EchoMojo
- EchoPlugin - Class in echo
-
The concrete implementation of the echo plugin functionality
- EchoPlugin(PluginLog, PluginParameters, EchoOutput) - Constructor for class echo.EchoPlugin
-
Creates a new instance of the EchoPlugin
- encoding - Variable in class echo.EchoMojo
-
Encoding for the messages.
- encoding - Variable in class echo.parameter.PluginParameters
- encoding - Variable in class echo.parameter.PluginParametersBuilder
- encoding - Variable in class echo.util.FileUtil
- error(String) - Method in interface echo.output.EchoOutput
-
The message will be output with error level
- error(String) - Method in class echo.output.MavenEchoOutput
- ERROR - echo.parameter.OutputLevelType
- ERROR_LEVEL_MSG - Static variable in enum echo.parameter.OutputLevelType
- ExceptionHandler - Class in echo.exception
-
Converts FailureExceptions to MojoFailureExceptions.
- ExceptionHandler(FailureException) - Constructor for class echo.exception.ExceptionHandler
-
Creates an ExceptionHandler with the exception to handle
- execute() - Method in class echo.EchoMojo
-
Execute plugin.
- execute() - Method in class echo.HelpMojo
- extractMessage() - Method in class echo.MessageExtractor
F
- fail(String) - Method in interface echo.output.EchoOutput
-
The message will be output with a failure level (exception will occur)
- fail(String) - Method in class echo.output.MavenEchoOutput
- FAIL - echo.parameter.OutputLevelType
- FailureException - Exception in echo.exception
-
An exception occurring during the execution of the plugin.
- FailureException(String) - Constructor for exception echo.exception.FailureException
-
Create a new instance with a message describing what happened
- FailureException(String, Throwable) - Constructor for exception echo.exception.FailureException
-
Create a new instance with message and what caused the failure
- fex - Variable in class echo.exception.ExceptionHandler
- fileUtil - Variable in class echo.EchoPlugin
- fileUtil - Variable in class echo.MessageExtractor
- FileUtil - Class in echo.util
-
Used to interface with file system
- FileUtil(PluginParameters, PluginLog) - Constructor for class echo.util.FileUtil
-
Create a new instance of the FileUtil
- FindFileInAbsolutePath - Class in echo.util
-
Try to retrieve content from an absolute file path.
- FindFileInAbsolutePath(PluginLog) - Constructor for class echo.util.FindFileInAbsolutePath
-
Creates a new instance of the class
- FindFileInClassPath - Class in echo.util
-
Try to retrieve content from the java class path.
- FindFileInClassPath(PluginLog) - Constructor for class echo.util.FindFileInClassPath
-
Creates a new instance of the class
- findNamedChild(Node, String) - Static method in class echo.HelpMojo
- findSingleChild(Node, String) - Static method in class echo.HelpMojo
- firstCharacter - Variable in class echo.CharacterOutput
- force - Variable in class echo.EchoMojo
-
Overwrite read-only destination files
- force - Variable in class echo.parameter.PluginParameters
- force - Variable in class echo.parameter.PluginParametersBuilder
- forceOverwrite - Variable in class echo.util.FileUtil
- format(String) - Method in class echo.output.NewlineFormatter
-
Format the message with the desired end of line characters
- formattedLineSeparator - Variable in class echo.parameter.LineSeparator
- fromFile - Variable in class echo.EchoMojo
-
If the message fetched from a file (or URL) instead of message tag
- fromFile - Variable in class echo.MessageExtractor
- fromFile - Variable in class echo.parameter.PluginParameters
- fromFile - Variable in class echo.parameter.PluginParametersBuilder
- fromFile - Variable in class echo.util.FileUtil
- fromString(String) - Static method in enum echo.parameter.OutputLevelType
-
Converts a string to the corresponding context
G
- generateOutput(char[]) - Method in class echo.CharacterOutput
- getAbsoluteFilePath() - Method in class echo.util.FindFileInAbsolutePath
- getAbsoluteFilePath() - Method in class echo.util.FindFileInClassPath
- getBasePath() - Method in class echo.parameter.PluginParameters
- getEncoding() - Method in class echo.parameter.PluginParameters
- getFileFromRelativeOrClassPath(File, String) - Method in class echo.util.FileUtil
- getFormattedLineSeparator() - Method in class echo.parameter.LineSeparator
- getFormattedMessage() - Method in class echo.MessageExtractor
-
Returns a message the is ready for output
- getFromFile() - Method in class echo.parameter.PluginParameters
- getFromFile() - Method in class echo.util.FileUtil
-
Retrieves the message from the location in attribute fromFile
- getIndentLevel(String) - Static method in class echo.HelpMojo
-
Gets the indentation level of the specified line.
- getInputStream() - Method in class echo.util.FindFileInAbsolutePath
-
Return stream to file path content
- getInputStream() - Method in class echo.util.FindFileInClassPath
-
Return stream to file content
- getLevel() - Method in class echo.parameter.PluginParameters
- getLineSeparator() - Method in class echo.parameter.PluginParameters
- getMessage() - Method in class echo.parameter.PluginParameters
- getOriginalMessage() - Method in class echo.MessageExtractor
- getOutput(String) - Method in class echo.CharacterOutput
-
Returns message content as a debug string, ready to be output
- getPropertyFromExpression(String) - Static method in class echo.HelpMojo
- getSingleChild(Node, String) - Static method in class echo.HelpMojo
- getToFile() - Method in class echo.parameter.PluginParameters
- getValue(Node, String) - Static method in class echo.HelpMojo
- goal - Variable in class echo.HelpMojo
-
The name of the goal for which to show help.
H
- HelpMojo - Class in echo
-
Display help information on echo-maven-plugin.
Callmvn echo:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details. - HelpMojo() - Constructor for class echo.HelpMojo
I
- indentSize - Variable in class echo.HelpMojo
-
The number of spaces per indentation level, should be positive.
- info(String) - Method in interface echo.output.EchoOutput
-
The message will be output with info level (default level)
- info(String) - Method in class echo.output.MavenEchoOutput
- info(String) - Method in class echo.output.MavenPluginLog
- info(String) - Method in interface echo.output.PluginLog
-
Send a message to the log in the info level.
- INFO - echo.parameter.OutputLevelType
- initLoggers() - Method in class echo.EchoMojo
- inputStream - Variable in class echo.util.FindFileInAbsolutePath
- inputStream - Variable in class echo.util.FindFileInClassPath
- isAppendToFile() - Method in class echo.parameter.PluginParameters
- isCharacterOutput() - Method in class echo.parameter.PluginParameters
- isForce() - Method in class echo.parameter.PluginParameters
- isFound() - Method in class echo.util.FindFileInAbsolutePath
-
Return true if stream is opened to file path
- isFound() - Method in class echo.util.FindFileInClassPath
-
Return true if stream is opened to file content
- isIllegalString() - Method in class echo.parameter.LineSeparator
- isNotEmpty(String) - Static method in class echo.HelpMojo
- isUrl() - Method in class echo.util.UrlWrapper
-
Returns true if the specified string is a URL
- isWriteOutput() - Method in class echo.CharacterOutput
L
- level - Variable in class echo.EchoMojo
-
Which output level the message should have.
- level - Variable in class echo.output.EchoOutputWrapper
- level - Variable in class echo.parameter.PluginParameters
- level - Variable in class echo.parameter.PluginParametersBuilder
- lineLength - Variable in class echo.HelpMojo
-
The maximum length of a display line, should be positive.
- lineSeparator - Variable in class echo.EchoMojo
-
Line separator messages.
- lineSeparator - Variable in class echo.output.NewlineFormatter
- lineSeparator - Variable in class echo.parameter.PluginParameters
- lineSeparator - Variable in class echo.parameter.PluginParametersBuilder
- LineSeparator - Class in echo.parameter
-
Encapsulates end of line character logic.
- LineSeparator(String) - Constructor for class echo.parameter.LineSeparator
-
Creates a line separator and makes sure that it is either \n, \r or \r\n
- lineSeparatorString - Variable in class echo.parameter.LineSeparator
M
- makeFileWritable(File) - Method in class echo.util.FileUtil
- MavenEchoOutput - Class in echo.output
-
Wraps the Maven standard output to decouple from output functionality
- MavenEchoOutput(Log) - Constructor for class echo.output.MavenEchoOutput
-
Creates an MavenEchoOutput wrapper
- mavenLogger - Variable in class echo.EchoMojo
- mavenPluginLog - Variable in class echo.EchoPlugin
- mavenPluginLog - Variable in class echo.util.FileUtil
- mavenPluginLog - Variable in class echo.util.FindFileInAbsolutePath
- mavenPluginLog - Variable in class echo.util.FindFileInClassPath
- MavenPluginLog - Class in echo.output
-
Wraps the Maven internal plugin logger to decouple from logging framework
- MavenPluginLog(Log) - Constructor for class echo.output.MavenPluginLog
-
Create new MavenLogger wrapper
- message - Variable in class echo.EchoMojo
-
The message text that should be echoed
- message - Variable in class echo.MessageExtractor
- message - Variable in class echo.parameter.PluginParameters
- message - Variable in class echo.parameter.PluginParametersBuilder
- messageExtractor - Variable in class echo.EchoPlugin
- MessageExtractor - Class in echo
-
Retrieves the message to output either from file or as an input parameter.
- MessageExtractor(PluginParameters, FileUtil) - Constructor for class echo.MessageExtractor
-
Create a new instance of the MessageExtractor
N
- newlineFormatter - Variable in class echo.MessageExtractor
- NewlineFormatter - Class in echo.output
-
Formats end of line characters according to desired format
- NewlineFormatter(PluginParameters) - Constructor for class echo.output.NewlineFormatter
-
Creates a new instance of NewlineSeparator
- NEWLINES_REG_EX - Static variable in class echo.output.NewlineFormatter
O
- openFile(File) - Method in class echo.util.FindFileInAbsolutePath
-
Try to open a stream to the file location
- openFile(String) - Method in class echo.util.FindFileInClassPath
-
Try to open a stream to the file location in the class path
- openStream() - Method in class echo.util.UrlWrapper
-
Open an input stream to the location of the url
- originalMessage - Variable in class echo.MessageExtractor
- output(String) - Method in class echo.output.EchoOutputWrapper
-
Echo the content to standard output (in Maven)
- OutputLevelType - Enum in echo.parameter
-
Defines the different levels a message can be output to.
- OutputLevelType() - Constructor for enum echo.parameter.OutputLevelType
- outputStringBuilder - Variable in class echo.CharacterOutput
P
- PLUGIN_HELP_PATH - Static variable in class echo.HelpMojo
- PluginLog - Interface in echo.output
-
Interface for the internal Maven plugin logger
- PluginParameters - Class in echo.parameter
-
Contains all parameters that are sent to the plugin
- PluginParameters(String, String, File, String, boolean, boolean, OutputLevelType, String, LineSeparator, boolean) - Constructor for class echo.parameter.PluginParameters
-
Creates an instance of PluginParameters with user-supplied plugin parameters
- PluginParametersBuilder - Class in echo.parameter
-
Creates a PluginParameter instance using the Builder pattern
- PluginParametersBuilder() - Constructor for class echo.parameter.PluginParametersBuilder
R
- READING_INPUT_FROM - Static variable in class echo.util.FileUtil
- repeat(String, int) - Static method in class echo.HelpMojo
-
Repeat a String
n
times to form a new string.
S
- saveToFile(String) - Method in class echo.util.FileUtil
-
Saves text output
- setDebug(boolean) - Method in class echo.parameter.PluginParametersBuilder
-
Set message content debug flag for plugin
- setFile(File, String, boolean, boolean) - Method in class echo.parameter.PluginParametersBuilder
-
Sets file output for plugin
- setFormatting(String, String) - Method in class echo.parameter.PluginParametersBuilder
-
Sets message formatting for plugin
- setLevel(String) - Method in class echo.parameter.PluginParametersBuilder
-
Sets message level fro plugin
- setMessage(String, String) - Method in class echo.parameter.PluginParametersBuilder
-
Sets input to plugin, either from message or file
- setup() - Method in class echo.EchoMojo
- skip - Variable in class echo.EchoMojo
-
Set this to 'true' to bypass echo plugin
- spec - Variable in class echo.util.UrlWrapper
T
- throwAsUnchecked(Exception) - Method in class echo.output.MavenEchoOutput
- throwMojoFailureException() - Method in class echo.exception.ExceptionHandler
-
Throw a MojoFailureException from the failure exception
- toFile - Variable in class echo.EchoMojo
-
If the message should be sent to a file instead of standard output
- toFile - Variable in class echo.parameter.PluginParameters
- toFile - Variable in class echo.parameter.PluginParametersBuilder
- toFile - Variable in class echo.util.FileUtil
- toLines(String, int, int, int) - Static method in class echo.HelpMojo
-
Splits the specified text into lines of convenient display length.
- toLines(List<String>, String, int, int) - Static method in class echo.HelpMojo
-
Adds the specified line to the output sequence, performing line wrapping if necessary.
U
- UNSUPPORTED_ENCODING - Static variable in exception echo.exception.FailureException
- UrlWrapper - Class in echo.util
-
Wraps the java URL class so that it exposes methods to determine if entered values are urls or not.
- UrlWrapper(String) - Constructor for class echo.util.UrlWrapper
-
Creates a new UrlWrapper with a supplied url
V
- valueOf(String) - Static method in enum echo.parameter.OutputLevelType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum echo.parameter.OutputLevelType
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- warning(String) - Method in interface echo.output.EchoOutput
-
The message will be output with warning level
- warning(String) - Method in class echo.output.MavenEchoOutput
- WARNING - echo.parameter.OutputLevelType
- wrappedLog - Variable in class echo.output.MavenEchoOutput
- wrappedLog - Variable in class echo.output.MavenPluginLog
- writeGoal(StringBuilder, String, Element) - Method in class echo.HelpMojo
- writeMessageToFile - Variable in class echo.EchoPlugin
- writeOutput - Variable in class echo.CharacterOutput
- writeParameter(StringBuilder, Node, Node) - Method in class echo.HelpMojo
All Classes All Packages