Top Description Interfaces Annotations Classes
[default module]

Package org.apache.logging.log4j.util

Annotations
@Export
@Version:2.22.0
Imports
org.osgi.annotation.bundle.Export, org.osgi.annotation.versioning.Version

Internal utility classes for the Log4j 2 API. Note that the use of any classes in this package is not supported. There are no guarantees for binary or logical compatibility in this package.

Interface Summary

Modifier and TypeInterface and Description
public interface
BiConsumer<
type of the first argument
K
,
type of the second argument
V
>

An operation that accepts two input arguments and returns no result.

public interface
IndexedReadOnlyStringMap

An extension of ReadOnlyStringMap that imposes a total ordering on its keys.

public interface
IndexedStringMap

An extension of StringMap that imposes a total ordering on its keys.

public interface
Lazy<
type of value
T
>

Provides a lazily-initialized value from a Supplier<T>.

public interface
MessageSupplier

Classes implementing this interface know how to supply Messages.

public interface
MultiFormatStringBuilderFormattable

A Message that can render itself in more than one way.

public interface
PropertySource

A source for global configuration properties.

public interface
ReadOnlyStringMap

A read-only collection of String keys mapped to values of arbitrary type.

public interface
StringBuilderFormattable

Objects that implement this interface can be converted to text, ideally without allocating temporary objects.

public interface
StringMap

Exposes methods to add and remove key-value pairs to and from ReadOnlyStringMap.

public interface
Supplier<
the type of values returned by this supplier
T
>

Deprecated
Consider this class private.
public interface
TriConsumer<
type of the first argument
K
,
type of the second argument
V
,
type of the third argument
S
>

An operation that accepts three input arguments and returns no result.

Annotation Summary

Modifier and TypeAnnotation and Description
public @interface
InternalApi

Indicates that the annotated element is considered an internal API to Log4j and should not be used by external code.

public @interface
PerformanceSensitive

Indicates that a particular annotated construct was written with certain performance constraints in mind that should be considered when modifying or testing.

Class Summary

Modifier and TypeClass and Description
public class
Activator

Consider this class private.

public class
Base64Util

Base64 encodes Strings.

public class
public class
Chars

Consider this class private.

public class
Constants

Log4j API Constants.

public class
EnglishEnums

Consider this class private.

public class
EnvironmentPropertySource

PropertySource implementation that uses environment variables as a source.

public class
FilteredObjectInputStream

Extends ObjectInputStream to only allow some built-in Log4j classes and caller-specified classes to be deserialized.

public class
InternalException

Exception thrown when an error occurs while accessing internal resources.

public class
LambdaUtil

Utility class for lambda support.

public class
pack-priv class
public class
LoaderUtil

Consider this class private.

pack-priv class
LowLevelLogUtil

PrintWriter-based logging utility for classes too low level to use org.apache.logging.log4j.status.StatusLogger.

public class
pack-priv class
PrivateSecurityManagerStackTraceUtil

Internal utility to share a fast implementation of #getCurrentStackTrace() with the java 9 implementation of StackLocator.

public class
ProcessIdUtil

Provides the PID of the current JVM.

public class
PropertiesPropertySource

PropertySource backed by a Properties instance.

public class
PropertiesUtil

Consider this class private.

public class
PropertyFilePropertySource

PropertySource backed by a properties file.

public abstract class
ProviderActivator

Utility class to register Log4j2 providers in an OSGI environment.

public class
ProviderUtil

Consider this class private.

public class
ServiceLoaderUtil

This class should be considered internal.

public class
SortedArrayStringMap

Consider this class private.

public class
StackLocator

Consider this class private.

public class
StackLocatorUtil

Consider this class private.

public class
StringBuilders

Consider this class private.

public class
Strings

Consider this class private.

public class
SystemPropertiesPropertySource

PropertySource backed by the current system properties.

public class
Timer

Primarily used in unit tests, but can be used to track elapsed time for a request or portion of any other operation so long as all the timer methods are called on the same thread in which it was started.

public class
Unbox

Utility for preventing primitive parameter values from being auto-boxed.