Interface Builder<T>
- Type Parameters:
T
- This builder creates instances of this class.
- All Known Subinterfaces:
AppenderComponentBuilder
,AppenderRefComponentBuilder
,ComponentBuilder<T>
,CompositeFilterComponentBuilder
,ConfigurationBuilder<T>
,CustomLevelComponentBuilder
,FilterableComponentBuilder<T>
,FilterComponentBuilder
,KeyValuePairComponentBuilder
,LayoutComponentBuilder
,LoggableComponentBuilder<T>
,LoggerComponentBuilder
,PropertyComponentBuilder
,RootLoggerComponentBuilder
,ScriptComponentBuilder
,ScriptFileComponentBuilder
- All Known Implementing Classes:
AppenderSet.Builder
,AsyncAppender.Builder
,AsyncLoggerConfig.Builder
,AsyncLoggerConfig.RootLogger.Builder
,AsyncWaitStrategyFactoryConfig.Builder
,BurstFilter.Builder
,ClassArbiter.Builder
,ColumnConfig.Builder
,ColumnMapping.Builder
,ConsoleAppender.Builder
,DefaultArbiter.Builder
,DefaultConfigurationBuilder
,DefaultRolloverStrategy.Builder
,DenyAllFilter.Builder
,DirectWriteRolloverStrategy.Builder
,DriverManagerConnectionSource.Builder
,EnvironmentArbiter.Builder
,FileAppender.Builder
,GelfLayout.Builder
,HtmlLayout.Builder
,HttpAppender.Builder
,JdbcAppender.Builder
,JmsAppender.Builder
,JsonLayout.Builder
,KafkaAppender.Builder
,KeyValuePair.Builder
,LevelMatchFilter.Builder
,LevelPatternSelector.Builder
,Log4jLogEvent.Builder
,LoggerConfig.Builder
,LoggerConfig.RootLogger.Builder
,MarkerPatternSelector.Builder
,MemoryMappedFileAppender.Builder
,MimeMessageBuilder
,MutableThreadContextMapFilter.Builder
,NoMarkerFilter.Builder
,NoSqlAppender.Builder
,OutputStreamAppender.Builder
,PatternLayout.Builder
,PatternLayout.SerializerBuilder
,PatternMatch.Builder
,PluginBuilder
,PosixViewAttributeAction.Builder
,PropertiesConfigurationBuilder
,RandomAccessFileAppender.Builder
,RollingFileAppender.Builder
,RollingRandomAccessFileAppender.Builder
,Routes.Builder
,RoutingAppender.Builder
,ScriptAppenderSelector.Builder
,ScriptArbiter.Builder
,ScriptPatternSelector.Builder
,SelectArbiter.Builder
,SmtpAppender.Builder
,SocketAddress.Builder
,SocketAppender.Builder
,SocketOptions
,SocketPerformancePreferences
,StringMatchFilter.Builder
,SyslogAppender.Builder
,SyslogLayout.Builder
,SystemPropertyArbiter.Builder
,TimeBasedTriggeringPolicy.Builder
,WriterAppender.Builder
,XmlLayout.Builder
,YamlLayout.Builder
public interface Builder<T>
A type of builder that can be used to configure and create a instances using a Java DSL instead of
through a configuration file. These builders are primarily useful for internal code and unit tests, but they can
technically be used as a verbose alternative to configuration files.
When creating plugin builders, it is customary to create the builder class as a public static inner class
called Builder
. For instance, the builder class for
PatternLayout
would be
PatternLayout.Builder
.
-
Method Details
-
build
T build()Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.- Returns:
- the configured instance.
- Throws:
ConfigurationException
- if there was an error building the object.
-
isValid
default boolean isValid() -
getErrorPrefix
Prefix to use to report errors from this builder.- Returns:
- The prefix of all logged errors.
-