Interface LogProperties.Listable

All Superinterfaces:

LogProperties

Enclosing interface:

LogProperties

public static interface LogProperties.Listable
extends LogProperties

Properties that can list the keys they hold, so that with LogConfig.DebugModeType.HELP (or LogConfig.DebugModeType.ALL) keys that were set but never read can be reported. A source that renames keys should name a key the way it is set in the source in LogProperties.description(String), since that is how a suggested key is reported.

Nested Class Summary

Nested classes/interfaces inherited from interface LogProperties

LogProperties.AbstractBuilder<T>, LogProperties.AbstractNested<N>, LogProperties.Builder, LogProperties.Listable, LogProperties.MutableLogProperties, LogProperties.StandardProperties

Modifier and Type	Interface	Description
static class	LogProperties.AbstractBuilder<T>	Abstract log properties builder.
static class	LogProperties.AbstractNested<N>	A base for properties read from a tree of nodes, such as a TOML, HOCON or YAML document, or a configuration system that holds its settings as a tree.
static final class	LogProperties.Builder	Builder for properties.
static interface	LogProperties.Listable	Properties that can list the keys they hold, so that with LogConfig.DebugModeType.HELP (or LogConfig.DebugModeType.ALL) keys that were set but never read can be reported.
static interface	LogProperties.MutableLogProperties	A log properties that can be mutated like a map.
static enum	LogProperties.StandardProperties	Common static log properties such as System properties ane environment variables.

Field Summary

Fields inherited from interface LogProperties

ALERTS_CAPACITY_PROPERTY, ALERTS_FAIL_PROPERTY, ALERTS_UNOBSERVED_ERRORS_ACTION_PROPERTY, ALERTS_UNUSED_KEY_PROPERTY, APPENDER_ENCODER_PROPERTY, APPENDER_FLAGS_PROPERTY, APPENDER_OUTPUT_PROPERTY, APPENDER_PREFIX, APPENDER_TYPE_PROPERTY, APPENDERS_PROPERTY, CALLER_LOGGER_PREFIX, CHANGE_LOGGER_PREFIX, CHANGE_MODE_PROPERTY, DEBUG_PROPERTY, DEFAULT_NAME, ENCODER_PREFIX, FILE_PROPERTY, FILTER, FILTER_PREFIX, GLOBAL_ANSI_MODE_PROPERTY, GLOBAL_APPENDER_LOCK_PROPERTY, GLOBAL_LINE_SEPARATOR_PROPERTY, GLOBAL_OPTIMIZE_PROPERTY, GLOBAL_QUEUE_ERROR_PROPERTY, GLOBAL_QUEUE_LEVEL_PROPERTY, GLOBAL_THREAD_LOCAL_PROPERTY, GROUP_PROPERTY, GROUPS_PROPERTY, KEY_VALUES_PREFIX, KEY_VALUES_SOURCES_PROPERTY, LEVEL_PREFIX, MAP_KEYS_SUFFIX, MESSAGE_FORMAT_STYLE_PROPERTY, NAME, OUTPUT_PREFIX, PARAMETER_PATTERN, PUBLISHER_PREFIX, ROOT_PREFIX, ROUTE_APPENDERS_PROPERTY, ROUTE_FILTERS_PROPERTY, ROUTE_FLAGS_PROPERTY, ROUTE_LEVEL_PREFIX, ROUTE_PREFIX, ROUTE_PUBLISHER_PROPERTY, ROUTES_PROPERTY, SEP

Modifier and Type	Field	Description
static final String	ALERTS_CAPACITY_PROPERTY	Maximum number of alerts LogAlerts holds in its ring buffer.
static final String	ALERTS_FAIL_PROPERTY	Alert level at which starting Rainbow Gum fails, like treating compiler warnings as errors: see LogAlerts.FailLevel.
static final String	ALERTS_UNOBSERVED_ERRORS_ACTION_PROPERTY	What LogAlerts does, once on start, if it has recorded at least one error alert and still has zero LogAlerts.Listeners registered - see LogAlerts.UnobservedErrorsAction for the three choices and LogAlerts.UnobservedErrorsAction.DUMP for the default.
static final String	ALERTS_UNUSED_KEY_PROPERTY	Alert level for property keys that were set but not read while starting: see LogAlerts.UnusedKeyLevel.
static final String	APPENDER_ENCODER_PROPERTY	Encoder appender property.
static final String	APPENDER_FLAGS_PROPERTY	Appender flags.
static final String	APPENDER_OUTPUT_PROPERTY	Output appender property.
static final String	APPENDER_PREFIX	Logging appender prefix for configuration.
static final String	APPENDER_TYPE_PROPERTY	Appender type (buffer/locking strategy).
static final String	APPENDERS_PROPERTY	Enabled Logging appenders.
static final String	CALLER_LOGGER_PREFIX	Per logger caller info properties prefix: see LogEvent.Caller.CallerType.
static final String	CHANGE_LOGGER_PREFIX	Per logger change properties prefix: see LogConfig.ChangePublisher.ChangeType.
static final String	CHANGE_MODE_PROPERTY	Whether runtime changes are on: see LogConfig.ChangePublisher.ChangeMode.
static final String	DEBUG_PROPERTY	Controls direct fail-safe bootstrap diagnostics.
static final String	DEFAULT_NAME	For properties keys that are parameterized with "name" the name often used if not specified is: "default".
static final String	ENCODER_PREFIX	Prefix of the properties configuring an appender's encoder, followed by the encoder's URI scheme, for example logging.appender.
static final String	FILE_PROPERTY	Logging file property for default single file appending.
static final String	FILTER	Key parameter for the name a filter is selected with in "logging.route.{name}.filters".
static final String	FILTER_PREFIX	Prefix of the properties configuring a route's filter, for example logging.route.default.filter.throttle.rate.
static final String	GLOBAL_ANSI_MODE_PROPERTY	Whether output uses ANSI escape codes: see LogConfig.Globals.AnsiMode.
static final String	GLOBAL_APPENDER_LOCK_PROPERTY	Which kind of lock appenders use: see LogConfig.Globals.AppenderLock.
static final String	GLOBAL_LINE_SEPARATOR_PROPERTY	The line separator formatters end lines and stack trace lines with: lf (default) for \n, crlf for \r\n, or platform for System.lineSeparator().
static final String	GLOBAL_OPTIMIZE_PROPERTY	Opts every appender/encoder that has not been given an explicit choice into whatever this release currently believes is the best buffering/locking strategy for the platform the process is actually running on, instead of the fixed defaults (LogAppender.AppenderType.LOCK_THREAD_LOCAL_BUFFER, a CharsetEncoder-based encode) used otherwise.
static final String	GLOBAL_QUEUE_ERROR_PROPERTY	The level threshold of queued events reported to standard error before Rainbow Gum is bound.
static final String	GLOBAL_QUEUE_LEVEL_PROPERTY	The level threshold of events captured before Rainbow Gum is fully bound.
static final String	GLOBAL_THREAD_LOCAL_PROPERTY	Whether the logging path may use a ThreadLocal: see LogConfig.Globals.ThreadLocalMode.
static final String	GROUP_PROPERTY	Group property with list of logger names.
static final String	GROUPS_PROPERTY	Enabled level groups.
static final String	KEY_VALUES_PREFIX	Key values namespace, for properties that configure where an event's key values come from.
static final String	KEY_VALUES_SOURCES_PROPERTY	A comma separated list of the key value sources whose contributors add key values to events, as the lowercase names of LogEventFactory.KeyValuesContributor.Source.Standard, for example defaults,slf4j.
static final String	LEVEL_PREFIX	Logging level properties prefix.
static final String	MAP_KEYS_SUFFIX	Suffix of the property listing a map's keys, see LogProperties.mapOrNull(String).
static final String	MESSAGE_FORMAT_STYLE_PROPERTY	How the java.util.logging, System.Logger and JBoss Logging message style formats a message with arguments, named after the implementation that formats the same way: jdk (default, alias jboss): MessageFormat is used only when the message has an argument index such as {0}, so It's done is logged as is.
static final String	NAME	A common key parameter is called name.
static final String	OUTPUT_PREFIX	Prefix of the properties configuring an appender's output, followed by the output's URI scheme, for example logging.appender.
static final Pattern	PARAMETER_PATTERN	Property prefix parameter pattern.
static final String	PUBLISHER_PREFIX	Prefix of the properties configuring a route's publisher, followed by the URI scheme of "logging.route.{name}.publisher.uri", for example logging.route.
static final String	ROOT_PREFIX	Logging properties prefix.
static final String	ROUTE_APPENDERS_PROPERTY	Appenders associated with a route comma separated.
static final String	ROUTE_FILTERS_PROPERTY	Comma separated names of the filters applied, in the order listed, to the route's events.
static final String	ROUTE_FLAGS_PROPERTY	Route flags.
static final String	ROUTE_LEVEL_PREFIX	Logging level properties prefix.
static final String	ROUTE_PREFIX	Route prefix for configuration.
static final String	ROUTE_PUBLISHER_PROPERTY	Logging publisher URI property.
static final String	ROUTES_PROPERTY	Routes enabled with names comma separated.
static final String	SEP	properties separator.

Method Summary

Modifier and Type	Method	Description
Collection<String>	keys()	The keys this source holds, as they are read (not renamed).

Methods inherited from interface LogProperties

description, findOrNull, forKey, forKey, listOrNull, mapOrNull, order, value, valueOrNull, visit

Modifier and Type	Method	Description
default String	description(String key)	Describes a key and by default is usually just the key.
default <T extends @Nullable Object> @Nullable T	findOrNull(String root, String key, BiFunction<LogProperties, String, @Nullable T> func)	Searches up a "." separated path using this properties to check for values.
default LogProperty	forKey(String key)	Starts resolving a property under key against this properties - the preferred entry point for looking up and converting a property, see LogProperty.
default LogProperty	forKey(String key, String nameParam)	Starts resolving a property under key, with a {name} placeholder in key interpolated to nameParam, against this properties.
default @Nullable List<String>	listOrNull(String key)	Gets a list or null if the key is missing and by default uses LogProperties.parseList(String).
default @Nullable Map<String,String>	mapOrNull(String key)	Gets a map or null if the key is missing and by default uses LogProperties.parseMap(String).
default int	order()	When log properties are coalesced this method is used to resolve order.
default String	value(String key, String fallback)	Analogous to System.getProperty(String, String) with the exception that the fallback cannot be null and the return cannot be null.
@Nullable String	valueOrNull(String key)	Analogous to System.getProperty(String).
default <R extends @Nullable Object> @Nullable R	visit(String key, BiFunction<LogProperties, String, @Nullable R> visitor)	Visits this properties with visitor, by default just applying visitor to this and key directly.

Method Details

keys

Collection<String> keys()

The keys this source holds, as they are read (not renamed).

Returns:

keys.