org.apache.camel
Enum ShutdownRunningTask

java.lang.Object
  java.lang.Enum<ShutdownRunningTask>
      org.apache.camel.ShutdownRunningTask

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ShutdownRunningTask>

public enum ShutdownRunningTask
extends java.lang.Enum<ShutdownRunningTask>

Represents the kind of options for what to do with the current task when shutting down.

By default the current task is allowed to complete. However some consumers such as BatchConsumer has pending tasks which you can configure to let it complete all those tasks as well.

• CompleteCurrentTaskOnly - Is the default behavior where a route consumer will be shutdown as fast as possible. Allowing it to complete its current task, but not to pickup pending tasks (if any).
• CompleteAllTasks - Allows a route consumer to do do its business which means that it will continue to complete any pending tasks (if any).

Notice: Most consumers only have a single tasks, but BatchConsumer can have many tasks and thus this option mostly apply to these kind of consumers.

Enum Constant Summary

CompleteAllTasks

CompleteCurrentTaskOnly

Method Summary

static ShutdownRunningTask	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ShutdownRunningTask[]	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

CompleteCurrentTaskOnly

public static final ShutdownRunningTask CompleteCurrentTaskOnly

CompleteAllTasks

public static final ShutdownRunningTask CompleteAllTasks

Method Detail

values

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

Returns:

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

valueOf

public static ShutdownRunningTask valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null