Module org.apache.logging.log4j
Package org.apache.logging.log4j.util
Utility APIs used elsewhere in Log4j API.
-
Interface Summary Interface Description BiConsumer<K,V> An operation that accepts two input arguments and returns no result.IndexedReadOnlyStringMap An extension ofReadOnlyStringMapthat imposes a total ordering on its keys.IndexedStringMap An extension ofStringMapthat imposes a total ordering on its keys.Lazy<T> Provides a lazily-initialized value from aSupplier<T>.MessageSupplier Classes implementing this interface know how to supplyMessages.MultiFormatStringBuilderFormattable A Message that can render itself in more than one way.PropertyEnvironment PropertyKey PropertySource A source for global configuration properties.ReadOnlyStringMap A read-only collection of String keys mapped to values of arbitrary type.ReloadablePropertySource Some property sources need to perform work when and Environment.reload is performce.StringBuilderFormattable Objects that implement this interface can be converted to text, ideally without allocating temporary objects.StringMap Exposes methods to add and remove key-value pairs to and fromReadOnlyStringMap.Supplier<T> Consider this class private. Classes implementing this interface know how to supply a value.TriConsumer<K,V,S> An operation that accepts three input arguments and returns no result. -
Class Summary Class Description Activator Consider this class private. OSGi bundle activator.Assert Utility class providing common validation logic.Cast Chars Consider this class private.Constants Log4j API Constants.ContextAwarePropertySource The original version of PropertySource did not support context aware PropertySources, so a call to getProperty(contextName, key) must resolve to getProperty(key).EnglishEnums Consider this class private.EnvironmentPropertySource PropertySource implementation that uses environment variables as a source.FilteredObjectInputStream Extended ObjectInputStream that only allows certain classes to be deserialized.JsonReader A simple JSON parser mapping tokens to basic Java types.LambdaUtil Utility class for lambda support.LazyBoolean LoaderUtil Consider this class private. Utility class for ClassLoaders.LoaderUtil.UrlResource URLandClassLoaderpair.LowLevelLogUtil PrintWriter-based logging utility for classes too low level to useStatusLogger.NameUtil OsgiServiceLocator ProcessIdUtil PropertiesPropertySource PropertySource backed by aPropertiesinstance.PropertiesUtil Consider this class private.PropertyFilePropertySource PropertySource backed by a properties file.PropertySource.Comparator Comparator for ordering PropertySource instances by priority.PropertySource.Util Utility methods useful for PropertySource implementations.ReflectionUtil Utility class for performing common reflective operations.ServiceLoaderUtil This class should be considered internal.ServiceRegistry Registry for service instances loaded fromServiceLoader.SortedArrayStringMap Consider this class private. Array-based implementation of theReadOnlyStringMapinterface.StackLocator Consider this class private. Determines the caller's class.StackLocatorUtil Consider this class private. Provides various methods to determine the caller class.StringBuilders Consider this class private.Strings Consider this class private.SystemPropertiesPropertySource PropertySource backed by the current system properties.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.Unbox Utility for preventing primitive parameter values from being auto-boxed. -
Enum Summary Enum Description Timer.Status -
Exception Summary Exception Description InternalException Exception thrown when an error occurs while accessing internal resources. -
Annotation Types Summary Annotation Type Description InternalApi Indicates that the annotated element is considered an internal API to Log4j and should not be used by external code.PerformanceSensitive Indicates that a particular annotated construct was written with certain performance constraints in mind that should be considered when modifying or testing.