org.apache.hadoop.util

Enum SignalLogger

java.lang.Object

java.lang.Enum<SignalLogger>

org.apache.hadoop.util.SignalLogger

All Implemented Interfaces:

Serializable, Comparable<SignalLogger>

@InterfaceAudience.Private
@InterfaceStability.Unstable
public enum SignalLogger
extends Enum<SignalLogger>

This class logs a message whenever we're about to exit on a UNIX signal. This is helpful for determining the root cause of a process' exit. For example, if the process exited because the system administrator ran a standard "kill," you would see 'EXITING ON SIGNAL SIGTERM' in the log.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Methods

Modifier and Type	Method and Description
void	register(org.apache.commons.logging.Log LOG) Register some signal handlers.
static SignalLogger	valueOf(String name) Returns the enum constant of this type with the specified name.
static SignalLogger[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final SignalLogger INSTANCE

Method Detail

values

public static SignalLogger[] 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 (SignalLogger c : SignalLogger.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SignalLogger 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

register

public void register(org.apache.commons.logging.Log LOG)

Register some signal handlers.

Parameters:

LOG - The log4j logfile to use in the signal handlers.