ComponentStatus (Infinispan Distribution 7.1.0.Beta1 API)

java.lang.Object
- java.lang.Enum<ComponentStatus>
- - org.infinispan.lifecycle.ComponentStatus

All Implemented Interfaces:

Comparable<ComponentStatus>
```
public enum ComponentStatus
extends Enum<ComponentStatus>
```
Different states a component may be in.

Since:

4.0

Author:

Manik Surtani

See Also:
Lifecycle

Enum Constant Summary

Enum Constants
Enum Constant and Description
`FAILED` The component is in a failed state due to a problem with one of the other lifecycle transition phases.
`INITIALIZING` The `start()` method has been called but not yet completed.
`INSTANTIATED` Object has been instantiated, but start() has not been called.
`RUNNING` The `start()` method has been completed and the component is running.
`STOPPING` The `stop()` method has been called but has not yet completed.
`TERMINATED` The `stop()` method has completed and the component has terminated.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`allowInvocations()`
`boolean`	`isStopping()`
`boolean`	`isTerminated()`
`boolean`	`needToDestroyFailedCache()`
`boolean`	`needToInitializeBeforeStart()`
`boolean`	`startAllowed()`
`boolean`	`startingUp()`
`boolean`	`stopAllowed()`
`static ComponentStatus`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ComponentStatus[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

- Enum Constant Detail
  - INSTANTIATED
```
public static final ComponentStatus INSTANTIATED
```
    Object has been instantiated, but start() has not been called.
  - INITIALIZING
```
public static final ComponentStatus INITIALIZING
```
    The start() method has been called but not yet completed.
  - RUNNING
```
public static final ComponentStatus RUNNING
```
    The start() method has been completed and the component is running.
  - STOPPING
```
public static final ComponentStatus STOPPING
```
    The stop() method has been called but has not yet completed.
  - TERMINATED
```
public static final ComponentStatus TERMINATED
```
    The stop() method has completed and the component has terminated.
  - FAILED
```
public static final ComponentStatus FAILED
```
    The component is in a failed state due to a problem with one of the other lifecycle transition phases.
- Method Detail
  - values
```
public static ComponentStatus[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ComponentStatus c : ComponentStatus.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ComponentStatus valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - needToDestroyFailedCache
```
public boolean needToDestroyFailedCache()
```
  - startAllowed
```
public boolean startAllowed()
```
  - needToInitializeBeforeStart
```
public boolean needToInitializeBeforeStart()
```
  - stopAllowed
```
public boolean stopAllowed()
```
  - allowInvocations
```
public boolean allowInvocations()
```
  - startingUp
```
public boolean startingUp()
```
  - isTerminated
```
public boolean isTerminated()
```
  - isStopping
```
public boolean isStopping()
```

Enum ComponentStatus

Enum Constant Summary

Method Summary

Enum Constant Detail

INSTANTIATED

INITIALIZING

RUNNING

STOPPING

TERMINATED

FAILED

Method Detail

values

valueOf

needToDestroyFailedCache

startAllowed

needToInitializeBeforeStart

stopAllowed

allowInvocations

startingUp

isTerminated

isStopping