All Classes and Interfaces (Apache Commons Lang 3.20.0 API)
Description: class index

# All Classes and Interfaces

Class
Description
AbstractCircuitBreaker<T>
Base class for circuit breakers.
AbstractCircuitBreaker.State
An internal enumeration representing the different states of a circuit breaker.
AbstractConcurrentInitializer<T,E>
Abstracts and defines operations for `ConcurrentInitializer` implementations.
AbstractConcurrentInitializer.AbstractBuilder<I,T,B,E>
Builds a new instance for subclasses.
AbstractFutureProxy<V>
Proxies to a `Future` for subclassing.
AbstractSupplier<T,B,E>
Abstracts supplying an instance of `T`.
AggregateTranslator
Deprecated.
As of 3.6, use Apache Commons Text AggregateTranslator.
AnnotationUtils
Helper methods for working with `Annotation` instances.
AppendableJoiner<T>
Joins an array or `Iterable` into an existing `Appendable` like a `StringBuilder`; with the goal for call sites to avoid creating intermediary Strings.
AppendableJoiner.Builder<T>
Builds instances of `AppendableJoiner`.
ArchUtils
Provides methods for identifying the architecture of the current JVM based on the `"os.arch"` system property.
ArrayFill
Fills and returns arrays in the fluent style.
ArraySorter
Sorts and returns arrays in the fluent style.
ArrayUtils
Operations on arrays, primitive arrays (like `int[]`) and primitive wrapper arrays (like `Integer[]`).
AtomicInitializer<T>
A specialized implementation of the `ConcurrentInitializer` interface based on an `AtomicReference` variable.
AtomicInitializer.Builder<I,T>
Builds a new instance.
AtomicSafeInitializer<T>
A specialized `ConcurrentInitializer` implementation which is similar to `AtomicInitializer`, but ensures that the `AbstractConcurrentInitializer.initialize()` method is called only once.
AtomicSafeInitializer.Builder<I,T>
Builds a new instance.
BackgroundInitializer<T>
A class that allows complex initialization operations in a background task.
BackgroundInitializer.Builder<I,T>
Builds a new instance.
BasicThreadFactory
An implementation of the `ThreadFactory` interface that provides some configuration options for the threads it creates.
BasicThreadFactory.Builder
A builder class for creating instances of `BasicThreadFactory`.
BitField
Supports operations on bit-mapped fields.
BooleanConsumer
A functional interface like `IntConsumer` but for `boolean`.
BooleanUtils
Operations on boolean primitives and Boolean objects.
Builder<T>
The Builder interface is designed to designate a class as a builder object in the Builder design pattern.
ByteConsumer
A functional interface like `IntConsumer` but for `byte`.
ByteSupplier
A functional interface like `IntSupplier`, but for a byte.
CalendarUtils
Helps use `Calendar`s.
CallableBackgroundInitializer<T>
A specialized `BackgroundInitializer` implementation that wraps a `Callable` object.
CharEncoding
Deprecated.
Java 7 introduced `StandardCharsets`, which defines these constants as `Charset` objects.
CharSequenceTranslator
Deprecated.
As of 3.6, use Apache Commons Text CharSequenceTranslator.
CharSequenceUtils
Operations on `CharSequence` that are `null` safe.
CharSet
A set of characters.
CharSetUtils
Operations on `CharSet` instances.
CharUtils
Operations on char primitives and Character objects.
CircuitBreaker<T>
An interface describing a Circuit Breaker component.
CircuitBreakingException
An exception class used for reporting runtime error conditions related to circuit breakers.
ClassLoaderUtils
Helps work with `ClassLoader`.
ClassPathUtils
Operations regarding the classpath.
ClassUtils
Operates on classes without using reflection.
ClassUtils.Interfaces
Inclusivity literals for `ClassUtils.hierarchy(Class, Interfaces)`.
CloneFailedException
Exception thrown when a clone cannot be created.
CodePointTranslator
Deprecated.
As of 3.6, use Apache Commons Text CharSequenceTranslator.
ComparableUtils
Helper translating `Comparable.compareTo(T)` results to booleans.
ComparableUtils.ComparableCheckBuilder<A>
Compares objects of a given generic type `A`.
CompareToBuilder
Assists in implementing `Comparable.compareTo(Object)` methods.
CompositeFormat
Deprecated.
As of 3.6, use Apache Commons Text CompositeFormat.
Computable<I,O>
Definition of an interface for a wrapper around a calculation that takes a single parameter and returns a result.
ConcurrentException
An exception class used for reporting error conditions related to accessing data of background tasks.
ConcurrentInitializer<T>
Defines the thread-safe initialization of objects.
ConcurrentRuntimeException
An exception class used for reporting runtime error conditions related to accessing data of background tasks.
ConcurrentUtils
A utility class providing functionality related to the `java.util.concurrent` package.
ConstantInitializer<T>
A very simple implementation of the `ConcurrentInitializer` interface which always returns the same object.
ConstructorUtils
Utility reflection methods focused on constructors, modeled after `MethodUtils`.
Consumers
Provides `Consumer` instances.
ContextedException
An exception that provides an easy and safe way to add contextual information.
ContextedRuntimeException
A runtime exception that provides an easy and safe way to add contextual information.
Conversion
Static methods to convert a type into another, with endianness and bit ordering awareness.
DateFormatUtils
Date and time formatting utilities and constants.
DateParser
DateParser is the "missing" interface for the parsing methods of `DateFormat`.
DatePrinter
DatePrinter is the "missing" interface for the format methods of `DateFormat`.
DateUtils
A suite of utilities surrounding the use of the `Calendar` and `Date` object.
DefaultExceptionContext
Default implementation of the context storing the label-value pairs for contexted exceptions.
Diff<T>
A `Diff` contains the differences between two `Diffable` class fields.
Diffable<T>
`Diffable` classes can be compared with other objects for differences.
DiffBuilder<T>
Assists in implementing `Diffable.diff(Object)` methods.
DiffBuilder.Builder<T>
Constructs a new instance.
DiffExclude
Excludes a field from being used by the `ReflectionDiffBuilder`.
DiffResult<T>
A `DiffResult` contains a collection of the differences between two `Diffable` objects.
DoubleRange
Specializes `NumberRange` for `Double`s.
DurationFormatUtils
Duration formatting utilities and constants.
DurationUtils
Utilities for `Duration`.
EntityArrays
Deprecated.
As of 3.6, use Apache Commons Text EntityArrays.
EnumUtils
Provides methods for Java enums.
EqualsBuilder
Assists in implementing `Object.equals(Object)` methods.
EqualsExclude
Excludes a field from being used by the various `reflectionEquals` methods defined on `EqualsBuilder`.
EventCountCircuitBreaker
A simple implementation of the Circuit Breaker pattern that counts specific events.
EventListenerSupport<L>
Manages a list of event listeners of a given generic type.
EventUtils
Provides some useful event-based utility methods.
ExceptionContext
Allows the storage and retrieval of contextual information based on label-value pairs for exceptions.
ExceptionUtils
Provides utilities for manipulating and examining `Throwable` objects.
ExtendedMessageFormat
Deprecated.
As of 3.6, use Apache Commons Text ExtendedMessageFormat.
Failable
This class provides utility functions, and classes for working with the `java.util.function` package, or more generally, with Java 8 lambdas.
FailableBiConsumer<T,U,E>
A functional interface like `BiConsumer` that declares a `Throwable`.
FailableBiFunction<T,U,R,E>
A functional interface like `BiFunction` that declares a `Throwable`.
FailableBiPredicate<T,U,E>
A functional interface like `BiPredicate` that declares a `Throwable`.
FailableBooleanSupplier<E>
A functional interface like `BooleanSupplier` that declares a `Throwable`.
FailableByteConsumer<E>
A functional interface like `ByteConsumer` that declares a `Throwable`.
FailableByteSupplier<E>
A functional interface like `IntSupplier`, but for a byte, that declares a `Throwable`.
FailableCallable<R,E>
A functional interface like `Callable` that declares a `Throwable`.
FailableConsumer<T,E>
A functional interface like `Consumer` that declares a `Throwable`.
FailableDoubleBinaryOperator<E>
A functional interface like `DoubleBinaryOperator` that declares a `Throwable`.
FailableDoubleConsumer<E>
A functional interface like `DoubleConsumer` that declares a `Throwable`.
FailableDoubleFunction<R,E>
A functional interface like `DoubleFunction` that declares a `Throwable`.
FailableDoublePredicate<E>
A functional interface like `DoublePredicate` that declares a `Throwable`.
FailableDoubleSupplier<E>
A functional interface like `DoubleSupplier` that declares a `Throwable`.
FailableDoubleToIntFunction<E>
A functional interface like `DoubleToIntFunction` that declares a `Throwable`.
FailableDoubleToLongFunction<E>
A functional interface like `DoubleToLongFunction` that declares a `Throwable`.
FailableDoubleUnaryOperator<E>
A functional interface like `DoubleUnaryOperator` that declares a `Throwable`.
FailableFunction<T,R,E>
A functional interface like `Function` that declares a `Throwable`.
FailableIntBinaryOperator<E>
A functional interface like `IntBinaryOperator` that declares a `Throwable`.
FailableIntConsumer<E>
A functional interface like `IntConsumer` that declares a `Throwable`.
FailableIntFunction<R,E>
A functional interface like `IntFunction` that declares a `Throwable`.
FailableIntPredicate<E>
A functional interface like `IntPredicate` that declares a `Throwable`.
FailableIntSupplier<E>
A functional interface like `IntSupplier` that declares a `Throwable`.
FailableIntToDoubleFunction<E>
A functional interface like `IntToDoubleFunction` that declares a `Throwable`.
FailableIntToFloatFunction<E>
A functional interface like `IntToDoubleFunction` but for `float` that declares a `Throwable`.
FailableIntToLongFunction<E>
A functional interface like `IntToLongFunction` that declares a `Throwable`.
FailableIntUnaryOperator<E>
A functional interface like `IntUnaryOperator` that declares a `Throwable`.
FailableLongBinaryOperator<E>
A functional interface like `LongBinaryOperator` that declares a `Throwable`.
FailableLongConsumer<E>
A functional interface like `LongConsumer` that declares a `Throwable`.
FailableLongFunction<R,E>
A functional interface like `LongFunction` that declares a `Throwable`.
FailableLongPredicate<E>
A functional interface like `LongPredicate` that declares a `Throwable`.
FailableLongSupplier<E>
A functional interface like `LongSupplier` that declares a `Throwable`.
FailableLongToDoubleFunction<E>
A functional interface like `LongToDoubleFunction` that declares a `Throwable`.
FailableLongToIntFunction<E>
A functional interface like `LongToIntFunction` that declares a `Throwable`.
FailableLongUnaryOperator<E>
A functional interface like `LongUnaryOperator` that declares a `Throwable`.
FailableObjDoubleConsumer<T,E>
A functional interface like `ObjDoubleConsumer` that declares a `Throwable`.
FailableObjIntConsumer<T,E>
A functional interface like `ObjIntConsumer` that declares a `Throwable`.
FailableObjLongConsumer<T,E>
A functional interface like `ObjLongConsumer` that declares a `Throwable`.
FailablePredicate<T,E>
A functional interface like `Predicate` that declares a `Throwable`.
FailableRunnable<E>
A functional interface like `Runnable` that declares a kind of `Throwable`.
FailableShortSupplier<E>
A functional interface like `IntSupplier` but for `short` that declares a `Throwable`.
FailableSupplier<T,E>
A functional interface like `Supplier` that declares a `Throwable`.
FailableToBooleanFunction<T,E>
A functional interface like a `ToBooleanFunction` that declares a `Throwable`.
FailableToDoubleBiFunction<T,U,E>
A functional interface like `ToDoubleBiFunction` that declares a `Throwable`.
FailableToDoubleFunction<T,E>
A functional interface like `ToDoubleFunction` that declares a `Throwable`.
FailableToIntBiFunction<T,U,E>
A functional interface like `ToIntBiFunction` that declares a `Throwable`.
FailableToIntFunction<T,E>
A functional interface like `ToIntFunction` that declares a `Throwable`.
FailableToLongBiFunction<T,U,E>
A functional interface like `ToLongBiFunction` that declares a `Throwable`.
FailableToLongFunction<T,E>
A functional interface like `ToLongFunction` that declares a `Throwable`.
FastDateFormat
FastDateFormat is a fast and thread-safe version of `SimpleDateFormat`.
FastDateParser
FastDateParser is a fast and thread-safe version of `SimpleDateFormat`.
FastDatePrinter
FastDatePrinter is a fast and thread-safe version of `SimpleDateFormat`.
FastTimeZone
Faster methods to produce custom time zones.
FieldUtils
Utilities for working with `Field`s by reflection.
FluentBitSet
A fluent `BitSet` with additional operations.
FormatFactory
Deprecated.
As of 3.6, use Apache Commons Text FormatFactory.
FormattableUtils
Deprecated.
As of 3.6, use Apache Commons Text FormattableUtils.
Fraction
`Fraction` is a `Number` implementation that stores fractions accurately.
Functions
Factory for `Function`.
Functions
Deprecated.
Use `Failable`.
Functions.FailableBiConsumer<O1,O2,T>
Deprecated.
Use `FailableBiConsumer`.
Functions.FailableBiFunction<O1,O2,R,T>
Deprecated.
Use `FailableBiFunction`.
Functions.FailableBiPredicate<O1,O2,T>
Deprecated.
Use `FailableBiPredicate`.
Functions.FailableCallable<R,T>
Deprecated.
Use `FailableCallable`.
Functions.FailableConsumer<O,T>
Deprecated.
Use `FailableConsumer`.
Functions.FailableFunction<I,R,T>
Deprecated.
Use `FailableFunction`.
Functions.FailablePredicate<I,T>
Deprecated.
Use `FailablePredicate`.
Functions.FailableRunnable<T>
Deprecated.
Use `FailableRunnable`.
Functions.FailableSupplier<R,T>
Deprecated.
Use `FailableSupplier`.
FutureTasks
Consists of utility methods that work with `FutureTask`.
HashCodeBuilder
Assists in implementing `Object.hashCode()` methods.
HashCodeExclude
Exclude a field from being used by the various `reflectionHashcode` methods defined on `HashCodeBuilder`.
IEEE754rUtils
Provides IEEE-754r variants of NumberUtils methods.
ImmutablePair<L,R>
An immutable pair consisting of two `Object` elements.
ImmutableTriple<L,M,R>
An immutable triple consisting of three `Object` elements.
InheritanceUtils
Utility methods focusing on inheritance.
IntegerRange
Specializes `NumberRange` for `Integer`s.
IntStreams
Factory for `IntStream`.
IntToCharFunction
Represents a function that accepts an int-valued argument and produces a char-valued result.
IterableStringTokenizer
A `StringTokenizer` that implements `Iterable``<String>` and conversion methods `IterableStringTokenizer.toList()` and `IterableStringTokenizer.toStream()`.
JavaUnicodeEscaper
Deprecated.
As of 3.6, use Apache Commons Text UnicodeEscaper.
JavaVersion
Enumerates all known versions of the Java specification.
LangCollectors
Implementations of `Collector` that implement various reduction operations.
LazyInitializer<T>
This class provides a generic implementation of the lazy initialization pattern.
LazyInitializer.Builder<I,T>
Builds a new instance.
LocaleUtils
Operations to assist when working with a `Locale`.
LockingVisitors
Combines the monitor and visitor pattern to work with `Lock`s as an alternative to synchronization.
LockingVisitors.LockVisitor<O,L>
Wraps a domain object and a lock for access by lambdas.
LockingVisitors.LockVisitor.LVBuilder<O,L,B>
Builds `LockingVisitors.LockVisitor` instances.
LockingVisitors.ReadWriteLockVisitor<O>
Wraps a `ReadWriteLock` and object to protect.
LockingVisitors.ReadWriteLockVisitor.Builder<O>
Builds `LockingVisitors.LockVisitor` instances.
LockingVisitors.ReentrantLockVisitor<O>
Wraps a `ReentrantLock` and object to protect.
LockingVisitors.ReentrantLockVisitor.Builder<O>
Builds `LockingVisitors.LockVisitor` instances.
LockingVisitors.StampedLockVisitor<O>
Wraps a `StampedLock` and object to protect.
LockingVisitors.StampedLockVisitor.Builder<O>
Builds `LockingVisitors.LockVisitor` instances.
LongRange
Specializes `NumberRange` for `Long`s.
LookupTranslator
Deprecated.
As of 3.6, use Apache Commons Text LookupTranslator.
Memoizer<I,O>
Definition of an interface for a wrapper around a calculation that takes a single parameter and returns a result.
MethodInvokers
Converts `Method` objects to lambdas.
MethodUtils
Utility reflection methods focused on `Method`s, originally from Commons BeanUtils.
MultiBackgroundInitializer
A specialized `BackgroundInitializer` implementation that can deal with multiple background initialization tasks.
MultiBackgroundInitializer.MultiBackgroundInitializerResults
A data class for storing the results of the background initialization performed by `MultiBackgroundInitializer`.
MultilineRecursiveToStringStyle
Works with `ToStringBuilder` to create a "deep" `toString`.
Mutable<T>
Provides mutable access to a value.
MutableBoolean
A mutable `boolean` wrapper.
MutableByte
A mutable `byte` wrapper.
MutableDouble
A mutable `double` wrapper.
MutableFloat
A mutable `float` wrapper.
MutableInt
A mutable `int` wrapper.
MutableLong
A mutable `long` wrapper.
MutableObject<T>
A mutable `Object` wrapper.
MutablePair<L,R>
A mutable pair consisting of two `Object` elements.
MutableShort
A mutable `short` wrapper.
MutableTriple<L,M,R>
A mutable triple consisting of three `Object` elements.
NotImplementedException
Thrown to indicate that a block of code has not been implemented.
NumberRange<N>
Specializes `Range` for `Number`s.
NumberUtils
Provides extra functionality for Java Number classes.
NumericEntityEscaper
Deprecated.
As of 3.6, use Apache Commons Text NumericEntityEscaper.
NumericEntityUnescaper
Deprecated.
As of 3.6, use Apache Commons Text NumericEntityUnescaper.
NumericEntityUnescaper.OPTION
Deprecated.
As of 3.18.0, use Apache Commons Text NumericEntityUnescaper.OPTION.
ObjectToStringComparator
Compares Object's `Object.toString()` values.
ObjectUtils
Operations on `Object`.
ObjectUtils.Null
Class used as a null placeholder where `null` has another meaning.
OctalUnescaper
Deprecated.
As of 3.6, use Apache Commons Text OctalUnescaper.
Pair<L,R>
A pair consisting of two elements.
Predicates
Factory for `Predicate`.
Processor
The `Processor` represents a microprocessor and defines some properties like architecture and type of the microprocessor.
Processor.Arch
The `Processor.Arch` enum defines the architecture of a microprocessor.
Processor.Type
The `Processor.Type` enum defines types of a microprocessor.
RandomStringUtils
Generates random `String`s.
RandomUtils
Supplements the standard `Random` class.
Range<T>
An immutable range of objects from a minimum to maximum point inclusive.
RecursiveToStringStyle
Works with `ToStringBuilder` to create a "deep" `toString`.
ReflectionDiffBuilder<T>
Assists in implementing `Diffable.diff(Object)` methods.
ReflectionDiffBuilder.Builder<T>
Constructs a new instance.
ReflectionToStringBuilder
Assists in implementing `Object.toString()` methods using reflection.
RegExUtils
Helpers to process Strings using regular expressions.
RuntimeEnvironment
Helps query the runtime environment.
SerializationException
Exception thrown when the Serialization process fails.
SerializationUtils
Assists with the serialization process and performs additional functionality based on serialization.
StandardToStringStyle
Works with `ToStringBuilder` to create a `toString`.
StopWatch
`StopWatch` provides a convenient API for timings.
StopWatch.Split
Stores a split as a label and duration.
StrBuilder
Deprecated.
As of 3.6, use Apache Commons Text TextStringBuilder.
Streams
Provides utility functions, and classes for working with the `java.util.stream` package, or more generally, with Java 8 lambdas.
Streams
Deprecated.
Use `Streams`.
Streams.ArrayCollector<E>
A Collector type for arrays.
Streams.ArrayCollector<O>
Deprecated.
Use `Streams.ArrayCollector`.
Streams.FailableStream<T>
A reduced, and simplified version of a `Stream` with failable method signatures.
Streams.FailableStream<O>
Deprecated.
Use `Streams.FailableStream`.
StringEscapeUtils
Deprecated.
As of 3.6, use Apache Commons Text StringEscapeUtils instead.
Strings
String operations where you choose case-sensitive `Strings.CS` vs. case-insensitive `Strings.CI` through a singleton instance.
Strings.Builder
Builds `Strings` instances.
StringUtils
Operations on `String` that are `null` safe.
StrLookup<V>
Deprecated.
As of 3.6, use Apache Commons Text StringLookupFactory.
StrMatcher
Deprecated.
As of 3.6, use Apache Commons Text StringMatcherFactory.
StrSubstitutor
Deprecated.
As of 3.6, use Apache Commons Text StringSubstitutor.
StrTokenizer
Deprecated.
As of 3.6, use Apache Commons Text StringTokenizer.
Suppliers
Helps use `Supplier`.
SystemProperties
Accesses current System Property names and values.
SystemUtils
Helpers for `System`.
ThreadUtils
Helpers for `Thread` and `ThreadGroup`.
ThreadUtils.NamePredicate
Deprecated.
Use a `Predicate`.
ThreadUtils.ThreadGroupPredicate
Deprecated.
Use a `Predicate`.
ThreadUtils.ThreadIdPredicate
Deprecated.
Use a `Predicate`.
ThreadUtils.ThreadPredicate
Deprecated.
Use a `Predicate`.
ThresholdCircuitBreaker
A simple implementation of the Circuit Breaker pattern that opens if the requested increment amount is greater than a given threshold.
TimedSemaphore
A specialized semaphore implementation that provides a number of permits in a given time frame.
TimedSemaphore.Builder
Builds new `TimedSemaphore`.
TimeZones
Helps dealing with `TimeZone`s.
ToBooleanBiFunction<T,U>
A function that accepts two arguments and produces a boolean result.
ToStringBuilder
Assists in implementing `Object.toString()` methods.
ToStringExclude
Excludes a field from being used by the `ReflectionToStringBuilder`.
ToStringStyle
Controls `String` formatting for `ToStringBuilder`.
ToStringSummary
Use this annotation on the fields to get the summary instead of the detailed information when using `ReflectionToStringBuilder`.
TriConsumer<T,U,V>
Represents an operation that accepts three input arguments and returns no result.
TriFunction<T,U,V,R>
Represents a function that accepts three arguments and produces a result.
Triple<L,M,R>
A triple consisting of three elements.
Typed<T>
Generalization of "has a type."
TypeLiteral<T>
Type literal comparable to `javax.enterprise.util.TypeLiteral`, made generally available outside the JEE context.
TypeUtils
Utility methods focusing on type inspection, particularly with regard to generics.
TypeUtils.WildcardTypeBuilder
`WildcardType` builder.
UncheckedException
Abstracts the concept of wrapping a checked exception as unchecked.
UncheckedExecutionException
Unchecked `ExecutionException`.
UncheckedFuture<V>
An `Future` that throws unchecked instead checked exceptions.
UncheckedIllegalAccessException
Unchecked `IllegalAccessException`.
UncheckedInterruptedException
Unchecked `InterruptedException`.
UncheckedReflectiveOperationException
Unchecked `ReflectiveOperationException`.
UncheckedTimeoutException
Unchecked `TimeoutException`.
UnicodeEscaper
Deprecated.
As of 3.6, use Apache Commons Text UnicodeEscaper.
UnicodeUnescaper
Deprecated.
As of 3.6, use Apache Commons Text UnicodeUnescaper.
UnicodeUnpairedSurrogateRemover
Deprecated.
As of 3.6, use Apache Commons Text UnicodeUnpairedSurrogateRemover.
Validate
This class assists in validating arguments.
WordUtils
Deprecated.
As of 3.6, use Apache Commons Text WordUtils.