Interface LogOutput.ProvidesEncoder

All Known Implementing Classes:

JfrLogOutput

Enclosing interface:

LogOutput

public static interface LogOutput.ProvidesEncoder

Marks an output that supplies its own LogEncoder instead of relying entirely on LogAppender.APPENDER_ENCODER_PROPERTY or LogEncoderRegistry.encoderForOutputType(OutputType). policy() decides whether that encoder can still be overridden:

• LogOutput.ProvidesEncoder.Policy.MANDATORY: encoder(String, LogConfig) is the only encoder this output will ever use. Configuring another one anyway - programmatically via LogAppender.Builder.encoder, or via LogAppender.APPENDER_ENCODER_PROPERTY - is a LogProperty.ValidationException, not a silent override.
• LogOutput.ProvidesEncoder.Policy.DEFAULT: encoder(String, LogConfig) is used only if nothing else is configured; either of the above always wins over it.

Neither policy is consulted at all if an output does not implement this interface in the first place - such an output has no opinion on its own encoder, and resolution proceeds exactly as if this interface did not exist.

See Also:

• LogAppender.Builder.build()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	LogOutput.ProvidesEncoder.Policy	Whether a LogOutput.ProvidesEncoder's encoder(String, LogConfig) can be overridden by another, explicitly configured encoder.

Method Summary

Modifier and Type	Method	Description
LogEncoder	encoder(String name, LogConfig config)	The encoder this output supplies, given the same name/config the output itself was provided with.
default LogOutput.ProvidesEncoder.Policy	policy()	Whether encoder(String, LogConfig) can be overridden by an explicitly configured encoder.

Method Details

encoder

LogEncoder encoder(String name,
 LogConfig config)

The encoder this output supplies, given the same name/config the output itself was provided with.

Parameters:

name - appender name.

config - config.

Returns:

encoder, see policy() for whether it can be overridden.

API Note

this method is only ever called once per appender resolution, so an implementation does not need to memoize the returned encoder itself.

policy

default LogOutput.ProvidesEncoder.Policy policy()

Whether encoder(String, LogConfig) can be overridden by an explicitly configured encoder. Defaults to LogOutput.ProvidesEncoder.Policy.DEFAULT - an implementation only needs to override this to return LogOutput.ProvidesEncoder.Policy.MANDATORY.

Returns:

policy.