Package org.acemq.amqp.api

Enum ApplyMode

java.lang.Object

java.lang.Enum<ApplyMode>

org.acemq.amqp.api.ApplyMode

All Implemented Interfaces:

Serializable, Comparable<ApplyMode>

public enum ApplyMode
extends Enum<ApplyMode>

How much a topology apply is allowed to do.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CREATE_ONLY	Create what is missing and leave everything else alone.
DRY_RUN	Work out the plan and change nothing.
VALIDATE	Change nothing and fail if anything is missing.

Method Summary

Modifier and Type	Method	Description
static ApplyMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ApplyMode[]	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 Details

DRY_RUN

public static final ApplyMode DRY_RUN

Work out the plan and change nothing.

What a build should run in review, and what a cautious start-up should log.

CREATE_ONLY

public static final ApplyMode CREATE_ONLY

Create what is missing and leave everything else alone.

The default, and deliberately not destructive: AMQP forbids changing most queue arguments in place, so a change that looks like an edit is really a delete and a recreate, which discards messages. That is a migration, and a migration should be a decision rather than a side effect of a start-up.

VALIDATE

public static final ApplyMode VALIDATE

Change nothing and fail if anything is missing.

For an environment where topology is provisioned separately and an application finding it absent is a deployment error rather than something to fix silently.

Method Details

values

public static ApplyMode[] values()

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

Returns:

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

valueOf

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