# All Classes and Interfaces

Class
Description
AbstractConverter
Adds default behaviors common to most converters, including checking for `null` values and wrapping exceptions in `ConverterException`.
BaseConsumerAdapter<A,T>
An abstract `FlowConsumerAdapter` that takes care setting/getting the adaptee and leaves only the `Consumer.accept(Object)` method to implement.
BasePolymorphicTypeProvider
Abstract implementation of `PolymorphicTypeProvider` offering convenience methods to facilitate registration.
BasePolymorphicTypeProvider.Registry
Helper for registering polymorphic types and sub-types.
BasePredicateAdapter<A,T>
An abstract `FlowPredicateAdapter` that takes care setting/getting the adaptee and leaves only the `Predicate.test(Object)` method to implement.
BeanException
Runtime exception indicating a bean-operation error.
BeanMapper
Simplified mapping of objects to/from XML, JSON, and Yaml.
BeanMapper.BeanMapperBuilder
BeanMapper.Format
BeanUtil
Bean/object utilities.
BooleanConverter
`Boolean` converter.
ByteArrayOutputStream
This class is an alternate version of Java `ByteArrayOutputStream`.
ByteBufferInputStream
Wraps a `ByteBuffer` in an `InputStream`.
CachedInputStream
`InputStream` wrapper that can be re-read any number of times.
CachedOutputStream
`OutputStream` wrapper that caches the output so it can be retrieved once as a `CachedInputStream`.
CachedStream
Caches I/O streams for reuse.
CachedStreamFactory
Factory for input/output streams caching values for repeat usage.
CertificateUtil
Certificate-related (e.g., SSL) utility methods.
CharacterConverter
`Character` converter.
CharsetConverter
`Charset` converter.
CharsetConverter.JsonDeserializer
JSON (Jackson) deserializer using this converter.
CharsetConverter.JsonSerializer
JSON (Jackson) serializer using this converter.
CharsetConverter.XmlAdapter
XML (JAXB) adapter using this converter.
CircularRange<T>
A range from a possible set of values that rolls over when defined circular start or end is reached.
ClassConverter
`Class` converter.
ClassFinder
Utility class for finding names of classes implementing an interface or class in directories or JAR files.
ClasspathInput
Load XML Schema resources input from Classpath.
ClasspathResourceResolver
Resolves XML Schema (XSD) include directives by looking for the specified resource on the Classpath.
ClassUtil
Class-related utility methods.
CollectionUtil
Collection-related utility methods.
Configurable<T>
The implementing class can be configured via the object returned by `Configurable.getConfiguration()`.
ConfigurationException
Runtime exception for configuration related issues.
ConfigurationLoader
Configuration file parser using Velocity template engine which supports variables, parse/include directives, and more).
ConfigurationLoader.ConfigurationLoaderBuilder
Consumers<T>
A list of `Consumer` instances, each triggered sequentially when this one is.
ContentFamily
Represents a family of content types.
ContentType
Represents a file Content-Type (also called MIME-Type or Media Type).
ContentTypeConverter
`ContentType` converter.
ContentTypeConverter.JsonDeserializer
JSON (Jackson) deserializer using this converter.
ContentTypeConverter.JsonSerializer
JSON (Jackson) serializer using this converter.
ContentTypeConverter.XmlAdapter
XML (JAXB) adapter using this converter.
Converter
Converts from Object to String and from String to Object.
ConverterException
Runtime exception indicating a conversion error.
CountingIterator<T>
Counts the number of time `CountingIterator.next()` was invoked.
Credentials
User credentials with an optionally encrypted password.
CustomIncludeDirective
CustomParseDirective
DataUnit
A `DataUnit` offers representation and conversion of various quantity of bytes/bits.
DataUnitFormatter
Formats a data unit to a human-readable string.
DataUnitParser
Parse a textual representation of a data unit and converts it into a `BigDecimal` representing the quantity for a given unit (e.g., bytes).
DataUnitParserException
Runtime exception when a `DataUnitParser` could not parse a string value.
DateConverter
`Date` converter using EPOCH representation for strings.
DateModel
Class abstracting several date and time implementations (`Date`, `LocalDate`, `ZonedDateTime`, etc.).
DateUtil
Deprecated.
Use more flexible `DateModel` instead.
DimensionConverter
`Dimension` converter.
DimensionConverter.JsonDeserializer
JSON (Jackson) deserializer using this converter.
DimensionConverter.JsonSerializer
JSON (Jackson) serializer using this converter.
DimensionConverter.XmlAdapter
XML (JAXB) adapter using this converter.
DurationConverter
`Duration` converter using milliseconds for string representation, but can also parse back plain-English durations.
DurationConverter.JsonDeserializer
JSON (Jackson) deserializer using this converter.
DurationConverter.JsonSerializer
JSON (Jackson) serializer using this converter.
DurationConverter.XmlAdapter
XML (JAXB) adapter using this converter.
DurationFormatter
Formats a duration to a string.
DurationParser
Parse a textual representation of a duration and converts it into a `long` millisecond value.
DurationParserException
Runtime exception when a `DurationParser` could not parse a string value.
DurationUnit
Duration unit.
DurationUnitFormatter
Formats a single duration unit according to supplied locale and plurality flag.
EmptyWithClosingTagXmlFactory
Version of `XmlFactory` that configures a `XmlPrettyPrinter` to write "empty" objects with a closing tag instead of self-closing.
EncryptionException
Runtime exception thrown if there is a problem with the encryption or decryption.
EncryptionKey
Pointer to the an encryption key, or the encryption key itself.
EncryptionKey.Source
EncryptionUtil
Simplified encryption and decryption methods using the Advanced Encryption Standard (AES) (since 1.15.0) with a supplied encryption key (which you can also think of as a passphrase, or password).
EnhancedXmlStreamWriter
A version of `XMLStreamWriter` that adds convenience methods for adding simple elements and typed attributes, as well as offering pretty-printing.
EnumConverter
`Enum` converter.
EqualsUtil
Convenience methods related to object equality.
ErrorHandlerCapturer
Collects XML validation errors.
ErrorHandlerFailer
Fails upon encountering first XML validation errors by throwing an `XmlValidationException`.
ErrorHandlerLogger
Logs XML validation warnings and errors.
Event
An immutable event.
Event.EventBuilder<C extends Event,B extends Event.EventBuilder<C,B>>
EventListener<T extends Event>
Listener of `Event`s.
EventManager
Manages event listeners and logs events.
ExceptionFilter
Filter for limiting the exceptions to be eligible for retry.
ExceptionUtil
Exception-related utility methods.
ExceptionUtil.ExceptionMessage
ExecException
An exception thrown by `ExecUtil`.
ExecUtil
Utility methods related to process execution.
ExtendedReferenceInsertionEventHandler
Velocity reference insertion event handler that when triggered, will try to resolve the reference against system properties or environment variables (in that order) if it could not resolved the normal way (before returning default value, if one was specified in the reference).
FifoMap<K,V>
Simple FIFO Map base on `LinkedHashMap`.
FileAlreadyLockedException
Checked exception thrown by `FileLocker` when trying to create a lock on an on an already locked file.
FileChangeListener
Listener for file changes, to be used with a `FileMonitor`.
FileConverter
GenericConverter for `File`.
FileConverter.JsonDeserializer
JSON (Jackson) deserializer using this converter.
FileConverter.JsonSerializer
JSON (Jackson) serializer using this converter.
FileConverter.XmlAdapter
XML (JAXB) adapter using this converter.
FileLocker
Simple `FileLock` wrapper to use operating-system file-locking ability to help with multi-processes management.
FileMonitor
Class monitoring a `File` for changes and notifying all registered `FileChangeListener`.
FileUtil
Utility methods when dealing with files and directories.
FileVisitor
Visitor to be used with `FileUtil.visit*` methods.
FilteredInputStream
Decorates an InputStream with a stream filter.
FlowConsumerAdapter<T>
FlowDeserializer<T>
Flow deserializer.
FlowDeserializerModifier
FlowMapperConfig
FlowModule
FlowPolymorphicType<T>
FlowPredicateAdapter<T>
FlowSerializer<T>
Flow serializer.
FlowSerializerModifier
FluentPropertyDescriptor
An implementation of `PropertyDescriptor` that is more relaxed when deriving method names from property names.
FunctionUtil
Deprecated.
use `Consumers` and `Predicates` instead.
GenericConverter
Converts strings to objects and objects to strings.
GenericJsonDeserializer<T>
GenericJsonModule
Jackson module providing (de)serializers for common types not handled natively by Jackson modules, or handled differently.
GenericJsonSerializer<T>
GenericXmlAdapter<T>
Host
Holds a host name and port.
HttpURL
This class act as a mutable URL, which could be a replacement or "wrapper" to the `URL` class.
ICachedStream
Deprecated.
Use `CachedStream` instead.
IDurationUnitFormatter
Deprecated.
Use `DurationUnitFormatter` instead.
IEventListener<T extends Event>
Deprecated.
Use `EventListener` instead
IExceptionFilter
Deprecated.
Use `ExceptionFilter` isntead.
IFileChangeListener
Deprecated.
Use `FileChangeListener` instead
IFileVisitor
Deprecated.
Use `FileVisitor` instead.
IInputStreamFilter
Deprecated.
use a String `Predicate` instead
IInputStreamListener
Deprecated.
Use `InputStreamListener` instead.
IMapChangeListener<K,V>
Deprecated.
Use `MapChangeListener` instead.
InputStreamConsumer
A stream consumer will read all it can from a stream in its own thread.
InputStreamLineListener
Listener that is being notified every time a line is processed from a given stream.
InputStreamListener
Listener that is being notified every time a chunk of bytes is processed from a given input stream.
InstantConverter
`Instant` converter.
InstantConverter.JsonDeserializer
JSON (Jackson) deserializer using this converter.
InstantConverter.JsonSerializer
JSON (Jackson) serializer using this converter.
InstantConverter.XmlAdapter
XML (JAXB) adapter using this converter.
IoUtil
I/O related utility methods.
IPipelineStage<T>
Deprecated.
Use `Predicate` instead.
IRetriable<T>
Deprecated.
Use `Retriable` instead
IXMLConfigurable
Deprecated.
Use `XmlConfigurable` instead.
IXMLFlowConsumerAdapter<T>
Deprecated.
Use `XmlFlowConsumerAdapter` instead.
IXMLFlowPredicateAdapter<T>
Deprecated.
Use `XmlFlowPredicateAdapter` instead.
JarCopier
Performs a version-sensitive copy a Jar file or directory containing Jar files over to another directory.
JarCopier.OnJarConflict
Encapsulate target jar conflict resolution options.
JarCopier.OnJarConflict.SourceAction
JarCopier.OnJarConflict.TargetAction
JarDuplicateFinder
Utility class for finding multiple instances of the same Jar that exists either in different folder or the same, with the same name and version, or same name but different versions.
JarDuplicates
Holds jar files that are considered duplicates.
JarFile
Simple Jar file representation holding name and version information.
JsonFlow
When adding the `FlowModule` to Jackson, use this annotation on `Consumer` properties to support flow (de)serialization.
JsonFlow.NoBuilder
No-op config mapper builder symbolizing no builder.
JsonXmlCollection
This annotation must be used with the `JsonXmlCollectionModule`.
JsonXmlCollectionDeserializer<T extends Collection<?>>
XML collection deserializer.
JsonXmlCollectionModule
Jackson module providing (de)serializers for Collections, so they can be written and read as JSON, Yaml, and XML without special hacks.
JsonXmlCollectionModule.CollectionDeserializerModifier
JsonXmlCollectionModule.CollectionSerializerModifier
JsonXmlCollectionSerializer<T extends Collection<?>>
XML collection serializer.
JsonXmlMap
This annotation must be used with the `JsonXmlMapModule`.
JsonXmlMapDeserializer<T extends Map<?,?>>
Deserializes a list of "entry" elements each having a "key" and "value" child elements into a Map.
JsonXmlMapModule
Jackson module providing (de)serializers for Map, so they can be written and read as XML without special hacks.
JsonXmlMapSerializer<T extends Map<?,?>>
Serializes Map as a list of "entry" elements each having a "key" and "value" child elements.
JsonXmlPropertiesDeserializer
XML deserializer for `Properties`.
JsonXmlPropertiesModule
Jackson module providing (de)serializers for `Properties`, so they can be written and read as XML without special hacks.
KeyStoreBuilder
Builder for creating a KeyStore.
LocalDateTimeConverter
`LocalDateTime` converter.
LocalDateTimeConverter.JsonDeserializer
JSON (Jackson) deserializer using this converter.
LocalDateTimeConverter.JsonSerializer
JSON (Jackson) serializer using this converter.
LocalDateTimeConverter.XmlAdapter
XML (JAXB) adapter using this converter.
LocaleConverter
`Locale` converter.
LocaleConverter.JsonDeserializer
JSON (Jackson) deserializer using this converter.
LocaleConverter.JsonSerializer
JSON (Jackson) serializer using this converter.
LocaleConverter.XmlAdapter
XML (JAXB) adapter using this converter.
MapChangeEvent<K,V>
A event representing a change of values in an `Map`.
MapChangeListener<K,V>
Listener for `Map` changes.
MapChangeSupport<K,V>
Here is an example of `MapChangeSupport` usage:
MapUtil
Map-related utility methods.
MemoryUtil
Memory-related utility methods.
MutableImage
Holds an image in memory and offers simple ways to do common operations.
MutableImage.Quality
NodeArrayList
A null-safe wrapper around `NodeList` that is also an `ArrayList`.
NumberConverter
Number conversion.
ObservableMap<K,V>
A map implementation that reports changes to added `MapChangeListener` instance.
Operator
Operators used by a few conditions based on comparable values (e.g., numbers, dates, etc.).
OsResource<T>
Provides an abstraction over operating-system specific resources (e.g. paths).
PackageManifest
A package manifest containing project or library identifying information.
PathConverter
GenericConverter for `Path`.
PathConverter.JsonDeserializer
JSON (Jackson) deserializer using this converter.
PathConverter.JsonSerializer
JSON (Jackson) serializer using this converter.
PathConverter.XmlAdapter
XML (JAXB) adapter using this converter.
PatternConverter
`Pattern` converter.
PatternConverter.JsonDeserializer
JSON (Jackson) deserializer using this converter.
PatternConverter.JsonSerializer
JSON (Jackson) serializer using this converter.
PatternConverter.XmlAdapter
XML (JAXB) adapter using this converter.
PercentFormatter
Formats percentage as string.
Pipeline<T>
Deprecated.
Use `Predicates` or `Predicate` chaining instead
PipelineException
Exception thrown when pipeline could not be executed properly.
PolymorphicTypeLoader
Finds and load all registered `PolymorphicTypeProvider`.
PolymorphicTypeProvider
Java service provider interface (SPI) for automatically registering types and sub-types to the `BeanMapper`
PredicatedConsumer<T>
A `Consumer` that only gets triggered if a given predicate is `true`.
Predicates<T>
A list of `Predicate` instances, matched as a group.
Properties
This class is a enhanced version of `Properties` that enforces the use of String keys and values internally, but offers many convenience methods for storing and retrieving multiple values of different types (e.g.
PropertiesException
`Properties` exception.
PropertyMatcher
Convenient way of matching values and/or fields (key) in a given `Properties`.
PropertyMatcherCondition
A simple XML condition matching `Properties` keys and values.
PropertyMatchers
Holds a collection of `PropertyMatcher` to perform multiple matches or replacements at once.
PropertySetter
Convenient way of handling the different ways a value (or values) can be set on a `Properties` instance.
ProxySettings
Convenience class for implementation requiring proxy settings.
QueryString
Provides utility methods for getting and setting attributes on a URL query string.
RbDurationUnitFormatter
Use localized properties files (`ResourceBundle`) to get the string representation of duration unit.
Regex
Builder and utility methods making it easier to construct and use regular expressions.
RegexFieldValueExtractor
Simplify extraction of field/value pairs (or "key/value") from text using regular expression.
RegexInputStreamFilter
Filters lines of text read from an InputStream decorated with `FilteredInputStream`, based on a given regular expression.
RelativeIncludeEventHandler
Velocity include event handler that check for includes both relative to a template location, and absolute to the current file system root otherwise.
ResourceLoader
Utility class for loading resource from class loader, relative to a given class.
Retriable<T>
Upon failure, the `run` method will get re-executed by a `Retrier` until successful or fails according to the `Retrier` conditions.
RetriableException
Exception thrown when `Retrier` failed to execute a `IRetriable` instance.
Retrier
This class is responsible for executing `Retriable` instances.
ReverseFileInputStream
`InputStream` implementation for streaming files in reverse order (from the end of file to its beginning).
SemanticVersion
Immutable semantic version representation, conforming to https://semver.org/ specifications.
SemanticVersion.SemanticVersionBuilder
SemanticVersionParser
Semantic version string parser.
SemanticVersionParser.SemanticVersionParserBuilder
SemanticVersionParserException
Exception thrown when the `SemanticVersionParser` could not parse a given string.
Sleeper
Convenience class to put to sleep the currently running thread.
SleeperException
Runtime `Sleep` exception wrapping any `InterruptedException` thrown.
Slf4jUtil
Provides convenience methods complementing the SLF4J offerings.
StreamException
Runtime exception when dealing with I/O streams.
StringConverter
`String` converter.
StringUtil
String-related utility methods not found in popular libraries.
SystemCommand
Represents a program to be executed by the underlying system (on the "command line").
SystemCommandException
An exception thrown by a executing `SystemCommand`.
SystemUtil
System-related convenience methods.
SystemUtil.Captured<T>
Holds possible return value and standard output/error when invoking `SystemUtil.callAndCaptureOutput(Callable)` or `SystemUtil.runAndCaptureOutput(Runnable)`.
SystemUtil.UncheckedCallableException
Runtime exception wrapping possible exceptions thrown by invoking `Callable` by one of `SystemUtil` methods.
TextMatcher
A configurable class offering a few different ways to perform text matching and replacing.
TextMatcher.Method
TextReader
Reads text form an input stream, splitting it wisely whenever the text is too large.
TimeIdGenerator
Generates a unique ID made out of the current time in milliseconds, combined with a thread-safe atomic sequence value that guarantees order and uniqueness within the same JVM.
Timer
Time the execution of arbitrary code and return the elapsed time.
UrlConverter
`URL` converter.
UrlException
Runtime exception thrown when dealing with URL failures.
UrlNormalizer
The general idea behind URL normalization is to make different URLs "equivalent" (i.e. eliminate URL variations pointing to the same resource).
UrlStreamer
Provides a quick and easy way to stream a URL.
UrlStreamer.HttpHost
VersionUtil
Deprecated, for removal: This API element is subject to removal in a future version.
Use `PackageManifest` instead.
WebFile
Access a web-based file as a local file.
Xml
XML DOM wrapper facilitating node querying and automatically creating, validating, and populating classes from/to XML, with support for `XmlConfigurable` and `JAXB`.
Xml.Builder
XmlConfigurable
Provides indications that a class is configurable via XML.
XmlCursor
XML cursor referencing the current position or element in XML traversal.
XmlException
Runtime exception for XML-related issues.
XmlFlow<T>
Treats an XML block as being a mix of predicate and consumer classes to create an execution "flow".
XmlFlowConsumerAdapter<T>
Adapts flow consuming elements so they can be treated as `Consumer`.
XmlFlowException
Runtime exception for XML-related issues.
XmlFlowPredicateAdapter<T>
Adapts flow <condition> elements so they can be treated as `Predicate`.
XmlFormatter
Simple XML Formatter.
XmlFormatter.Builder
XmlFormatter.Builder.AttributeWrap
XmlUtil
Utility XML-related methods.
XmlValidationError
A configuration error resulting from validation.
XmlValidationError.Severity
XmlValidationException
Runtime exception for configuration related issues.
XpathUtil
XPath-related utility methods.
YearMonthDay
Immutable class holding a specific date made only of the year, month, and day.
YearMonthDayInterval
An immutable date interval where both the start and end are inclusive.
ZonedDateTimeConverter
`ZonedDateTime` converter.
ZonedDateTimeConverter.JsonDeserializer
JSON (Jackson) deserializer using this converter.
ZonedDateTimeConverter.JsonSerializer
JSON (Jackson) serializer using this converter.
ZonedDateTimeConverter.XmlAdapter
XML (JAXB) adapter using this converter.
ZonedDateTimeParser
Parses a string representation of a date to a `ZonedDateTime`.
ZonedDateTimeParser.TimeUnit
ZonedDateTimeParser.ZonedDateTimeParserBuilder
ZoneIdConverter
`ZoneIdConverter` converter.
ZoneIdConverter.JsonDeserializer
JSON (Jackson) deserializer using this converter.
ZoneIdConverter.JsonSerializer
JSON (Jackson) serializer using this converter.
ZoneIdConverter.XmlAdapter
XML (JAXB) adapter using this converter.