Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
C
- 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 - Enum constant in enum class echo.parameter.OutputLevelType
E
- echo - package echo
- echo.exception - package echo.exception
- echo.output - package echo.output
- echo.parameter - package echo.parameter
- echo.util - package echo.util
- 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
- 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 - Enum constant in enum class 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.HelpMojo
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 - Enum constant in enum class echo.parameter.OutputLevelType
- FailureException - Exception Class in echo.exception
-
An exception occurring during the execution of the plugin.
- FailureException(String) - Constructor for exception class echo.exception.FailureException
-
Create a new instance with a message describing what happened
- FailureException(String, Throwable) - Constructor for exception class echo.exception.FailureException
-
Create a new instance with message and what caused the failure
- 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
- format(String) - Method in class echo.output.NewlineFormatter
-
Format the message with the desired end of line characters
G
- getBasePath() - Method in class echo.parameter.PluginParameters
- getEncoding() - Method in class echo.parameter.PluginParameters
- getFormattedLineSeparator() - Method in class echo.parameter.LineSeparator
- getFromFile() - Method in class echo.parameter.PluginParameters
- getFromFile() - Method in class echo.util.FileUtil
-
Retrieves the message from the location in attribute fromFile
- getLevel() - Method in class echo.parameter.PluginParameters
- getLineSeparator() - Method in class echo.parameter.PluginParameters
- getMessage() - Method in class echo.parameter.PluginParameters
- getToFile() - Method in class echo.parameter.PluginParameters
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
- 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 - Enum constant in enum class echo.parameter.OutputLevelType
- isAppendToFile() - Method in class echo.parameter.PluginParameters
- isCharacterOutput() - Method in class echo.parameter.PluginParameters
- isForce() - Method in class echo.parameter.PluginParameters
L
- LineSeparator - Class in echo.parameter
-
Encapsulates end of line character logic.
M
- 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
- 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
N
- 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
O
- output(String) - Method in class echo.output.EchoOutputWrapper
-
Echo the content to standard output (in Maven)
- OutputLevelType - Enum Class in echo.parameter
-
Defines the different levels a message can be output to.
P
- 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
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
T
- throwMojoFailureException() - Method in class echo.exception.ExceptionHandler
-
Throw a MojoFailureException from the failure exception
U
- UNSUPPORTED_ENCODING - Static variable in exception class echo.exception.FailureException
V
- valueOf(String) - Static method in enum class echo.parameter.OutputLevelType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class echo.parameter.OutputLevelType
-
Returns an array containing the constants of this enum class, 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 - Enum constant in enum class echo.parameter.OutputLevelType
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form