Index (Maven Plugin Utils 1.4.0 API)

A B C D E F G H I L M N O P R S T V

A

AbstractSimpleSanitizer - Class in biz.gabrys.maven.plugin.util.parameter.sanitizer: Helps in implementing sanitizers which specify that the parameter value is valid based on a simple condition.
AbstractSimpleSanitizer(boolean) - Constructor for class biz.gabrys.maven.plugin.util.parameter.sanitizer.AbstractSimpleSanitizer: Constructs a new instance and sets information on whether parameter current value is valid.
AbstractValueToStringConverter - Class in biz.gabrys.maven.plugin.util.parameter.converter: Helps in implementing converters which are null safe.
AbstractValueToStringConverter() - Constructor for class biz.gabrys.maven.plugin.util.parameter.converter.AbstractValueToStringConverter: Constructs a new instance.
accept(File) - Method in class biz.gabrys.maven.plugin.util.io.LoggingFileFilter: It additionally logs (in debug mode) for normal file information whether it is included or excluded.
accept(File, String) - Method in class biz.gabrys.maven.plugin.util.io.LoggingFileFilter: It additionally logs (in debug mode) for normal file information whether it is included or excluded.
accept(File, String) - Method in class biz.gabrys.maven.plugin.util.io.RegexFileFilter: This method delegates logic to RegexFileFilter.isAcceptable(File).
accept(File) - Method in class biz.gabrys.maven.plugin.util.io.RegexFileFilter: This method delegates logic to RegexFileFilter.isAcceptable(File).
addDependencies(String...) - Method in class biz.gabrys.maven.plugin.util.classpath.ContextClassLoaderExtender: Adds all dependencies with specified types to context class loader.
addDependencies(Collection<String>) - Method in class biz.gabrys.maven.plugin.util.classpath.ContextClassLoaderExtender: Adds all dependencies with specified types to context class loader.
addToContextClassLoader(List<URL>) - Method in class biz.gabrys.maven.plugin.util.classpath.ContextClassLoaderExtender: Adds artifacts URLs to context class loader.
AlwaysValidSanitizer - Class in biz.gabrys.maven.plugin.util.parameter.sanitizer: Value sanitizer which treats all values as valid.
AlwaysValidSanitizer() - Constructor for class biz.gabrys.maven.plugin.util.parameter.sanitizer.AlwaysValidSanitizer: Constructs a new instance.
AntFileScanner - Class in biz.gabrys.maven.plugin.util.io: File scanner which uses Ant patterns to match files.
AntFileScanner() - Constructor for class biz.gabrys.maven.plugin.util.io.AntFileScanner: Constructs a new instance.
AntFileScanner(Log) - Constructor for class biz.gabrys.maven.plugin.util.io.AntFileScanner: Constructs a new instance.
append(String, Object) - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder: Appends a parameter with a valid value.
append(String, Object, ValueToStringConverter) - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder: Appends a parameter with a valid value.
append(String, Object, ValueSanitizer) - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder: Appends a parameter with a valid value.
append(String, Object, ValueToStringConverter, ValueSanitizer) - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder: Appends a parameter with a valid value.
ArrayToStringConverter - Class in biz.gabrys.maven.plugin.util.parameter.converter: Responsible for converting arrays to string representation.
ArrayToStringConverter() - Constructor for class biz.gabrys.maven.plugin.util.parameter.converter.ArrayToStringConverter: Constructs a new instance.

B

biz.gabrys.maven.plugin.util.classpath - package biz.gabrys.maven.plugin.util.classpath: Contains tools to operate on classpath.
biz.gabrys.maven.plugin.util.io - package biz.gabrys.maven.plugin.util.io: Contains classes related with I/O operations.
biz.gabrys.maven.plugin.util.parameter - package biz.gabrys.maven.plugin.util.parameter: Contains utilities to operate on Mojos and methods parameters.
biz.gabrys.maven.plugin.util.parameter.converter - package biz.gabrys.maven.plugin.util.parameter.converter: Contains converters responsible for converting parameters values to string representation.
biz.gabrys.maven.plugin.util.parameter.sanitizer - package biz.gabrys.maven.plugin.util.parameter.sanitizer: Contains sanitizers responsible for sanitizing (convert from invalid to valid form) Mojos parameters values.
biz.gabrys.maven.plugin.util.timer - package biz.gabrys.maven.plugin.util.timer: Contains types responsible for counting the execution time.

C

CollectionToStringConverter - Class in biz.gabrys.maven.plugin.util.parameter.converter: Responsible for converting collections to string representation.
CollectionToStringConverter() - Constructor for class biz.gabrys.maven.plugin.util.parameter.converter.CollectionToStringConverter: Constructs a new instance.
conatiner - Variable in class biz.gabrys.maven.plugin.util.parameter.sanitizer.LazySimpleSanitizer: Sanitized value container.
Container(Object, ValueToStringConverter, ValueSanitizer) - Constructor for class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder.Container: Constructs a new instance.
ContextClassLoaderExtender - Class in biz.gabrys.maven.plugin.util.classpath: Responsible for adding Maven project dependencies to classpath.
ContextClassLoaderExtender(MavenProject, Log) - Constructor for class biz.gabrys.maven.plugin.util.classpath.ContextClassLoaderExtender: Creates a new instance.
convert(Object) - Method in class biz.gabrys.maven.plugin.util.parameter.converter.AbstractValueToStringConverter: Converts a parameter value to string representation.
convert(Object) - Method in class biz.gabrys.maven.plugin.util.parameter.converter.ArrayToStringConverter: Converts a parameter value to string representation.
convert(Object) - Method in class biz.gabrys.maven.plugin.util.parameter.converter.ObjectToStringConverter: Converts a parameter value to string representation.
convert(Object) - Method in interface biz.gabrys.maven.plugin.util.parameter.converter.ValueToStringConverter: Converts a parameter value to string representation.
convert2(Object) - Method in class biz.gabrys.maven.plugin.util.parameter.converter.AbstractValueToStringConverter: Converts a parameter value to string representation.
convert2(Object) - Method in class biz.gabrys.maven.plugin.util.parameter.converter.CollectionToStringConverter
convert2(Object) - Method in class biz.gabrys.maven.plugin.util.parameter.converter.DefaultValueToStringConverter
convertToFiles(File, String[]) - Method in class biz.gabrys.maven.plugin.util.io.AntFileScanner: Converts paths found by scanner to files collection with absolute paths.
create(File) - Method in class biz.gabrys.maven.plugin.util.io.DestinationFileCreator: Creates a destination file in the output directory.
create(ScannerPatternFormat, Log) - Method in class biz.gabrys.maven.plugin.util.io.ScannerFactory: Creates a new scanner related with the pattern format.
createDirectoryScanner() - Method in class biz.gabrys.maven.plugin.util.io.AntFileScanner: Creates a DirectoryScanner which will be used to find all files whose match filters.
createDisplayText(Artifact) - Method in class biz.gabrys.maven.plugin.util.classpath.ContextClassLoaderExtender: Creates a text representation of the Artifact.
createFileFilter(File, String[], String[]) - Method in class biz.gabrys.maven.plugin.util.io.RegexFileScanner: Creates a IOFileFilter which will be used to find all files whose match filters.
createLines() - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder: Creates all lines which will be logged by the logger.
createParametersLines() - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder: Creates one line for every appended parameter.
createParameterValue(ParametersLogBuilder.Container) - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder: Creates a string representation of the parameter value.
createParemeterLine(String, ParametersLogBuilder.Container) - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder: Creates a line for single parameter.

D

debug() - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder: Logs appended parameters using debug mode.
debugInclusion(Log, File, boolean) - Static method in class biz.gabrys.maven.plugin.util.io.LoggerUtils: Logs (in debug mode) information whether normal file is included or excluded.
DebugInternalLoggerAdapter(Log) - Constructor for class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder.DebugInternalLoggerAdapter: Constructs a new instance.
DefaultValueToStringConverter - Class in biz.gabrys.maven.plugin.util.parameter.converter: Default ValueToStringConverter which allows to converts basic types.
DefaultValueToStringConverter() - Constructor for class biz.gabrys.maven.plugin.util.parameter.converter.DefaultValueToStringConverter: Constructs a new instance.
DestinationFileCreator - Class in biz.gabrys.maven.plugin.util.io: Responsible for creating a virtual (not physical) destination file in the output directory based on the source directory, the source file and the output file name pattern.
DestinationFileCreator(File, File) - Constructor for class biz.gabrys.maven.plugin.util.io.DestinationFileCreator: Constructs a new instance.
DestinationFileCreator(File, File, String) - Constructor for class biz.gabrys.maven.plugin.util.io.DestinationFileCreator: Constructs a new instance.

E

equals(Object) - Method in class biz.gabrys.maven.plugin.util.timer.Time

F

FILE_NAME_PARAMETER - Static variable in class biz.gabrys.maven.plugin.util.io.DestinationFileCreator: The pattern in output file name which will be replaced by source file name without extension.
FileScanner - Interface in biz.gabrys.maven.plugin.util.io: Responsible for scanning a directory for files whose match certain criteria.
filterArtifacts(Collection<Artifact>, Collection<String>) - Method in class biz.gabrys.maven.plugin.util.classpath.ContextClassLoaderExtender: Filters artifacts based on the type.

G

getCanonicalPath(File) - Static method in class biz.gabrys.maven.plugin.util.io.RegexFileFilter: Returns canonical path for a file.
getConverter() - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder.Container: Returns a converter responsible for converting parameter value to string representation.
getFiles(File, String[], String[]) - Method in class biz.gabrys.maven.plugin.util.io.AntFileScanner
getFiles(File, String[], String[]) - Method in interface biz.gabrys.maven.plugin.util.io.FileScanner: Returns files contained by a directory.
getFiles(File, String[], String[]) - Method in class biz.gabrys.maven.plugin.util.io.RegexFileScanner: Returns files contained by a directory.
getSanitizer() - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder.Container: Returns a sanitizer responsible for sanitizing parameter value.
getStartedTimer() - Static method in class biz.gabrys.maven.plugin.util.timer.SystemTimer: Returns a new started timer.
getTime() - Method in class biz.gabrys.maven.plugin.util.timer.SystemTimer: Returns a current counted time.
getTime() - Method in interface biz.gabrys.maven.plugin.util.timer.Timer: Returns a current counted time.
getValue() - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder.Container: Returns a parameter value.
getValue() - Method in interface biz.gabrys.maven.plugin.util.parameter.sanitizer.LazySimpleSanitizer.ValueContainer: Returns a sanitized value.

H

hashCode() - Method in class biz.gabrys.maven.plugin.util.timer.Time

I

info() - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder: Logs appended parameters using info mode.
InfoInternalLoggerAdapter(Log) - Constructor for class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder.InfoInternalLoggerAdapter: Constructs a new instance.
isAcceptable(File) - Method in class biz.gabrys.maven.plugin.util.io.RegexFileFilter: Checks whether a file should be accepted by this filter.
isEnabled() - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder.DebugInternalLoggerAdapter
isEnabled() - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder.InfoInternalLoggerAdapter
isEnabled() - Method in interface biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder.InternalLogger: Checks whether a logger is enabled.
isExcluded(String) - Method in class biz.gabrys.maven.plugin.util.io.LoggingDirectoryScanner: It additionally logs (in debug mode) for normal file information whether it is included or excluded.
isValid(Object) - Method in class biz.gabrys.maven.plugin.util.parameter.sanitizer.AbstractSimpleSanitizer: Returns a condition value specified during construction of this object.
isValid(Object) - Method in class biz.gabrys.maven.plugin.util.parameter.sanitizer.AlwaysValidSanitizer: Returns true.
isValid(Object) - Method in interface biz.gabrys.maven.plugin.util.parameter.sanitizer.ValueSanitizer: Checks whether a parameter value is valid or not.

L

LazySimpleSanitizer - Class in biz.gabrys.maven.plugin.util.parameter.sanitizer: Simple value sanitizer which returns a declared lazy loaded sanitized value when specified condition returns true.
LazySimpleSanitizer(boolean, LazySimpleSanitizer.ValueContainer) - Constructor for class biz.gabrys.maven.plugin.util.parameter.sanitizer.LazySimpleSanitizer: Constructs a new instance.
LazySimpleSanitizer.ValueContainer - Interface in biz.gabrys.maven.plugin.util.parameter.sanitizer: Responsible for returning sanitized value.
log(CharSequence) - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder.DebugInternalLoggerAdapter
log(CharSequence) - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder.InfoInternalLoggerAdapter
log(CharSequence) - Method in interface biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder.InternalLogger: Logs a line.
log(ParametersLogBuilder.InternalLogger) - Method in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder: Logs appended parameters using ParametersLogBuilder.InternalLogger.
logger - Variable in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder: Logger used to log parameters.
LoggerUtils - Class in biz.gabrys.maven.plugin.util.io: Provides tools to log information related with files.
LoggingDirectoryScanner - Class in biz.gabrys.maven.plugin.util.io: Extended version of the DirectoryScanner which adds logger instructions in debug mode.
LoggingDirectoryScanner(Log) - Constructor for class biz.gabrys.maven.plugin.util.io.LoggingDirectoryScanner: Constructs a new instance.
LoggingFileFilter - Class in biz.gabrys.maven.plugin.util.io: Decorator which adds logger instructions (in debug mode) to an instance of the IOFileFilter.
LoggingFileFilter(IOFileFilter, Log) - Constructor for class biz.gabrys.maven.plugin.util.io.LoggingFileFilter: Constructs a new instance.

M

matches(String, String[]) - Static method in class biz.gabrys.maven.plugin.util.io.RegexFileFilter: Checks whether a file path matches at least one patter from patterns.

N

NULL_STRING - Static variable in class biz.gabrys.maven.plugin.util.parameter.converter.AbstractValueToStringConverter: String representation of null value.

O

ObjectToStringConverter - Class in biz.gabrys.maven.plugin.util.parameter.converter: Responsible for converting objects to string representation.
ObjectToStringConverter() - Constructor for class biz.gabrys.maven.plugin.util.parameter.converter.ObjectToStringConverter: Constructs a new instance.

P

parameters - Variable in class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder: Stores parameters names and associated containers.
ParametersLogBuilder - Class in biz.gabrys.maven.plugin.util.parameter: Builder which allows to log Mojos parameters values.
ParametersLogBuilder(Log) - Constructor for class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder: Constructs a new object.
ParametersLogBuilder(Map<String, ParametersLogBuilder.Container>, Log) - Constructor for class biz.gabrys.maven.plugin.util.parameter.ParametersLogBuilder: Constructs a new object.
ParametersLogBuilder.Container - Class in biz.gabrys.maven.plugin.util.parameter: Container which stores parameter value and associated converter and sanitizer.
ParametersLogBuilder.DebugInternalLoggerAdapter - Class in biz.gabrys.maven.plugin.util.parameter: Adapts Log to ParametersLogBuilder.InternalLogger API which uses debug mode.
ParametersLogBuilder.InfoInternalLoggerAdapter - Class in biz.gabrys.maven.plugin.util.parameter: Adapts Log to ParametersLogBuilder.InternalLogger API which uses info mode.
ParametersLogBuilder.InternalLogger - Interface in biz.gabrys.maven.plugin.util.parameter: Used to adaptation instance of the Log to logger used in the ParametersLogBuilder.log(InternalLogger) method.
ParameterUtils - Class in biz.gabrys.maven.plugin.util.parameter: Provides tools to work with method parameters.

R

RegexFileFilter - Class in biz.gabrys.maven.plugin.util.io: File filter which uses regular expressions to accept files.
RegexFileFilter(File, String[], String[]) - Constructor for class biz.gabrys.maven.plugin.util.io.RegexFileFilter: Constructs a new instance.
RegexFileFilterException - Exception in biz.gabrys.maven.plugin.util.io: Thrown to indicate that an error occurred during file-filtering process by regular expressions.
RegexFileFilterException(Throwable) - Constructor for exception biz.gabrys.maven.plugin.util.io.RegexFileFilterException: Constructs a new instance with the specified cause.
RegexFileScanner - Class in biz.gabrys.maven.plugin.util.io: File scanner which uses regular expressions to match files.
RegexFileScanner() - Constructor for class biz.gabrys.maven.plugin.util.io.RegexFileScanner: Constructs a new instance.
RegexFileScanner(Log) - Constructor for class biz.gabrys.maven.plugin.util.io.RegexFileScanner: Constructs a new instance.
resolveArtifactsUrls(Collection<Artifact>) - Method in class biz.gabrys.maven.plugin.util.classpath.ContextClassLoaderExtender: Returns URLs whose represents artifacts.

S

sanitize(Object) - Method in class biz.gabrys.maven.plugin.util.parameter.sanitizer.AbstractSimpleSanitizer: Sanitizes a parameter invalid value to valid form.
sanitize(Object) - Method in class biz.gabrys.maven.plugin.util.parameter.sanitizer.AlwaysValidSanitizer: Throws an UnsupportedOperationException.
sanitize(Object) - Method in interface biz.gabrys.maven.plugin.util.parameter.sanitizer.ValueSanitizer: Sanitizes a parameter invalid value to valid form.
sanitize2(Object) - Method in class biz.gabrys.maven.plugin.util.parameter.sanitizer.AbstractSimpleSanitizer: Sanitizes a parameter invalid value to valid form.
sanitize2(Object) - Method in class biz.gabrys.maven.plugin.util.parameter.sanitizer.LazySimpleSanitizer: Returns a sanitized value returned by the container (specified during construction of this object).
sanitize2(Object) - Method in class biz.gabrys.maven.plugin.util.parameter.sanitizer.SimpleSanitizer: Returns a sanitized value specified during construction of this object.
sanitizedValue - Variable in class biz.gabrys.maven.plugin.util.parameter.sanitizer.SimpleSanitizer: The sanitized value.
ScannerFactory - Class in biz.gabrys.maven.plugin.util.io: Responsible for creating new instances of the FileScanner by the ScannerPatternFormat.
ScannerFactory() - Constructor for class biz.gabrys.maven.plugin.util.io.ScannerFactory: Constructs a new instance.
ScannerPatternFormat - Enum in biz.gabrys.maven.plugin.util.io: Represents inclusion and exclusion fileset patterns format used by the FileScanner.
setFileNamePattern(String) - Method in class biz.gabrys.maven.plugin.util.io.DestinationFileCreator: Sets an output file name pattern.
SimpleSanitizer - Class in biz.gabrys.maven.plugin.util.parameter.sanitizer: Simple value sanitizer which returns a declared sanitized value when specified condition returns true.
SimpleSanitizer(boolean, Object) - Constructor for class biz.gabrys.maven.plugin.util.parameter.sanitizer.SimpleSanitizer: Constructs a new instance.
start() - Method in class biz.gabrys.maven.plugin.util.timer.SystemTimer
start() - Method in interface biz.gabrys.maven.plugin.util.timer.Timer: Starts counting time.
stop() - Method in class biz.gabrys.maven.plugin.util.timer.SystemTimer
stop() - Method in interface biz.gabrys.maven.plugin.util.timer.Timer: Stops counting time.
SystemTimer - Class in biz.gabrys.maven.plugin.util.timer: Default implementation of the Timer which based on the System.currentTimeMillis() method.
SystemTimer() - Constructor for class biz.gabrys.maven.plugin.util.timer.SystemTimer: Constructs a new instance.

T

Time - Class in biz.gabrys.maven.plugin.util.timer: Represents time counted by a Timer.
Time(long) - Constructor for class biz.gabrys.maven.plugin.util.timer.Time: Constructs a new instance.
Timer - Interface in biz.gabrys.maven.plugin.util.timer: Represents timer responsible for counting the execution time.
toMilliseconds() - Method in class biz.gabrys.maven.plugin.util.timer.Time: Returns milliseconds representation of this object.
toPattern(String) - Static method in enum biz.gabrys.maven.plugin.util.io.ScannerPatternFormat: Returns a scanner pattern format by name (case insensitive).
toString() - Method in class biz.gabrys.maven.plugin.util.timer.Time: Returns a string representation of the time in human-readable format.

V

valid - Variable in class biz.gabrys.maven.plugin.util.parameter.sanitizer.AbstractSimpleSanitizer: Information whether parameter current value is valid.
valueOf(String) - Static method in enum biz.gabrys.maven.plugin.util.io.ScannerPatternFormat: Returns the enum constant of this type with the specified name.
values() - Static method in enum biz.gabrys.maven.plugin.util.io.ScannerPatternFormat: Returns an array containing the constants of this enum type, in the order they are declared.
ValueSanitizer - Interface in biz.gabrys.maven.plugin.util.parameter.sanitizer: Responsible for sanitizing (convert from invalid to valid form) Mojo parameters values.
ValueToStringConverter - Interface in biz.gabrys.maven.plugin.util.parameter.converter: Responsible for converting parameters values to string representation.
verifyNotNull(String, Object) - Static method in class biz.gabrys.maven.plugin.util.parameter.ParameterUtils: Verifies that a parameter value is not null.

A B C D E F G H I L M N O P R S T V