Package org.apache.logging.log4j.core
Interface LifeCycle
-
- All Known Subinterfaces:
Appender
,Configuration
,Filter
,Filterable
,LifeCycle2
- All Known Implementing Classes:
AbstractAppender
,AbstractConfiguration
,AbstractFileAppender
,AbstractFilter
,AbstractFilterable
,AbstractLifeCycle
,AbstractOutputStreamAppender
,AbstractTriggeringPolicy
,AbstractWriterAppender
,AppenderAdapter.Adapter
,AppenderControl
,AsyncAppender
,AsyncLoggerConfig
,AsyncLoggerConfig.RootLogger
,AsyncLoggerConfigDisruptor
,AsyncLoggerContext
,BuiltConfiguration
,BurstFilter
,CompositeConfiguration
,CompositeFilter
,CompositeTriggeringPolicy
,ConfigurationScheduler
,ConsoleAppender
,CountingNoOpAppender
,CronTriggeringPolicy
,DefaultConfiguration
,DefaultShutdownCallbackRegistry
,DenyAllFilter
,DynamicThresholdFilter
,FailoverAppender
,FileAppender
,FilterAdapter
,HttpAppender
,IdlePurgePolicy
,JsonConfiguration
,LevelMatchFilter
,LevelRangeFilter
,Log4j1Configuration
,LoggerConfig
,LoggerConfig.RootLogger
,LoggerContext
,MapFilter
,MarkerFilter
,MemoryMappedFileAppender
,NoMarkerFilter
,NoOpTriggeringPolicy
,NullAppender
,NullConfiguration
,OnStartupTriggeringPolicy
,OutputStreamAppender
,PropertiesConfiguration
,PropertiesConfiguration
,RandomAccessFileAppender
,RegexFilter
,RewriteAppender
,RollingFileAppender
,RollingRandomAccessFileAppender
,RoutingAppender
,ScriptAppenderSelector
,ScriptFilter
,SizeBasedTriggeringPolicy
,SmtpAppender
,SocketAppender
,StringMatchFilter
,StructuredDataFilter
,SyslogAppender
,ThreadContextMapFilter
,ThresholdFilter
,TimeBasedTriggeringPolicy
,TimeFilter
,WatchManager
,WriterAppender
,XmlConfiguration
,XmlConfiguration
public interface LifeCycle
All proper Java frameworks implement some sort of object life cycle. In Log4j, the main interface for handling the life cycle context of an object is this one. An object first starts in theLifeCycle.State.INITIALIZED
state by default to indicate the class has been loaded. From here, calling thestart()
method will change this state toLifeCycle.State.STARTING
. After successfully being started, this state is changed toLifeCycle.State.STARTED
. When thestop()
is called, this goes into theLifeCycle.State.STOPPING
state. After successfully being stopped, this goes into theLifeCycle.State.STOPPED
state. In most circumstances, implementation classes should store theirLifeCycle.State
in avolatile
field or inside anAtomicReference
dependent on synchronization and concurrency requirements.- See Also:
AbstractLifeCycle
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
LifeCycle.State
Status of a life cycle like aLoggerContext
.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description LifeCycle.State
getState()
Gets the life-cycle state.void
initialize()
boolean
isStarted()
boolean
isStopped()
void
start()
void
stop()
-
-
-
Method Detail
-
getState
LifeCycle.State getState()
Gets the life-cycle state.- Returns:
- the life-cycle state
-
initialize
void initialize()
-
start
void start()
-
stop
void stop()
-
isStarted
boolean isStarted()
-
isStopped
boolean isStopped()
-
-