Package org.apache.logging.log4j.core
Class AbstractLifeCycle
- java.lang.Object
-
- org.apache.logging.log4j.core.AbstractLifeCycle
-
- All Implemented Interfaces:
LifeCycle
,LifeCycle2
- Direct Known Subclasses:
AbstractFilter
,AbstractFilterable
,AbstractTriggeringPolicy
,AsyncLoggerConfigDisruptor
,CompositeFilter
,ConfigurationScheduler
,IdlePurgePolicy
,LoggerContext
,WatchManager
public class AbstractLifeCycle extends Object implements LifeCycle2
A life cycle to be extended.Wraps a
LifeCycle.State
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle
LifeCycle.State
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_STOP_TIMEOUT
static TimeUnit
DEFAULT_STOP_TIMEUNIT
protected static Logger
LOGGER
Allow subclasses access to the status logger without creating another instance.
-
Constructor Summary
Constructors Constructor Description AbstractLifeCycle()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
equalsImpl(Object obj)
LifeCycle.State
getState()
Gets the life-cycle state.protected static Logger
getStatusLogger()
Gets the status logger.protected int
hashCodeImpl()
void
initialize()
boolean
isInitialized()
boolean
isStarted()
boolean
isStarting()
boolean
isStopped()
boolean
isStopping()
protected void
setStarted()
protected void
setStarting()
protected void
setState(LifeCycle.State newState)
protected void
setStopped()
protected void
setStopping()
void
start()
void
stop()
boolean
stop(long timeout, TimeUnit timeUnit)
Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.protected boolean
stop(Future<?> future)
-
-
-
Field Detail
-
DEFAULT_STOP_TIMEOUT
public static final int DEFAULT_STOP_TIMEOUT
- See Also:
- Constant Field Values
-
DEFAULT_STOP_TIMEUNIT
public static final TimeUnit DEFAULT_STOP_TIMEUNIT
-
LOGGER
protected static final Logger LOGGER
Allow subclasses access to the status logger without creating another instance.
-
-
Method Detail
-
getStatusLogger
protected static Logger getStatusLogger()
Gets the status logger.- Returns:
- the status logger.
-
equalsImpl
protected boolean equalsImpl(Object obj)
-
getState
public LifeCycle.State getState()
Description copied from interface:LifeCycle
Gets the life-cycle state.
-
hashCodeImpl
protected int hashCodeImpl()
-
isInitialized
public boolean isInitialized()
-
isStarting
public boolean isStarting()
-
isStopping
public boolean isStopping()
-
setStarted
protected void setStarted()
-
setStarting
protected void setStarting()
-
setState
protected void setState(LifeCycle.State newState)
-
setStopped
protected void setStopped()
-
setStopping
protected void setStopping()
-
initialize
public void initialize()
- Specified by:
initialize
in interfaceLifeCycle
-
stop
protected boolean stop(Future<?> future)
-
stop
public boolean stop(long timeout, TimeUnit timeUnit)
Description copied from interface:LifeCycle2
Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.- Specified by:
stop
in interfaceLifeCycle2
- Parameters:
timeout
- the maximum time to waittimeUnit
- the time unit of the timeout argument- Returns:
- true if the receiver was stopped cleanly and normally, false otherwise.
-
-