Module org.eclipse.jgit

Package org.eclipse.jgit.internal.util

Enum Class ShutdownHook

java.lang.Object

java.lang.Enum<ShutdownHook>

org.eclipse.jgit.internal.util.ShutdownHook

All Implemented Interfaces:

Serializable, Comparable<ShutdownHook>, java.lang.constant.Constable

public enum ShutdownHook
extends Enum<ShutdownHook>

The singleton ShutdownHook provides a means to register ShutdownHook.Listeners that are run when JGit is uninstalled, either

• in an OSGi framework when this bundle is deactivated, or
• otherwise, when the JVM as a whole shuts down.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ShutdownHook.Listener	Object that needs to cleanup on shutdown.

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE	Singleton

Method Summary

Modifier and Type	Method	Description
boolean	isShutdownInProgress()	Whether a JGit shutdown is in progress
boolean	register(ShutdownHook.Listener l)	Register object that needs cleanup during JGit shutdown if it is not already registered.
boolean	unregister(ShutdownHook.Listener l)	Unregister object that no longer needs cleanup during JGit shutdown if it is still registered.
static ShutdownHook	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ShutdownHook[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final ShutdownHook INSTANCE

Singleton

Method Details

values

public static ShutdownHook[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ShutdownHook valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

register

public boolean register(ShutdownHook.Listener l)

Register object that needs cleanup during JGit shutdown if it is not already registered. Registration is disabled when JGit shutdown is already in progress.

Parameters:

l - the object to call ShutdownHook.Listener.onShutdown() on when JGit shuts down

Returns:

true if this object has been registered

unregister

public boolean unregister(ShutdownHook.Listener l)

Unregister object that no longer needs cleanup during JGit shutdown if it is still registered. Unregistration is disabled when JGit shutdown is already in progress.

Parameters:

l - the object registered to be notified for cleanup when the JVM shuts down

Returns:

true if this object is no longer registered

isShutdownInProgress

public boolean isShutdownInProgress()

Whether a JGit shutdown is in progress

Returns:

true if a JGit shutdown is in progress