org.apache.ambari.server.stack.upgrade

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

org.apache.ambari.server.stack.upgrade.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>

public enum Direction
extends Enum<Direction>

Indicates if an sequence of Groups should be for an upgrade or a downgrade.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWNGRADE
UPGRADE

Method Summary

Modifier and Type	Method and Description
String	getPast(boolean proper)
String	getPlural(boolean proper)
String	getPreposition() Gets the preposition based on the direction.
String	getText(boolean proper)
String	getVerb(boolean proper)
boolean	isDowngrade()
boolean	isUpgrade()
static Direction	valueOf(String name) Returns the enum constant of this type with the specified name.
static Direction[]	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

UPGRADE

public static final Direction UPGRADE

DOWNGRADE

public static final Direction DOWNGRADE

Method Detail

values

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

Returns:

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

valueOf

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

isUpgrade

public boolean isUpgrade()

Returns:

true if the direction is for upgrade. Convenience instead of equality checking.

isDowngrade

public boolean isDowngrade()

Returns:

true if the direction is for downgrade. Convenience instead of equality checking.

getText

public String getText(boolean proper)

Parameters:

proper - true to make the first letter captilized

Returns:

"upgrade" or "downgrade"

getPast

public String getPast(boolean proper)

Parameters:

proper - true to make the first letter captilized

Returns:

"upgraded" or "downgraded"

getPlural

public String getPlural(boolean proper)

Parameters:

proper - true to make the first letter captilized

Returns:

"upgrades" or "downgrades"

getVerb

public String getVerb(boolean proper)

Parameters:

proper - true to make the first letter captilized

Returns:

"upgrading" or "downgrading"

getPreposition

public String getPreposition()

Gets the preposition based on the direction. Since the repository is singular, it will either be "to repo" or "from repo".

Returns:

"to" or "from"