com.atlassian.greenhopper.model.lexorank
Enum LexoRankBucket

java.lang.Object
  java.lang.Enum<LexoRankBucket>
      com.atlassian.greenhopper.model.lexorank.LexoRankBucket

All Implemented Interfaces:

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

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

Represents a logical "bucket" in which a current LexoRank value is placed in. LexoRank values are moved from one bucket to another by the rebalancing process.

See Also:

LexoRankBalancer

Enum Constant Summary

BUCKET_0

BUCKET_1

BUCKET_2

Method Summary

java.lang.String	format()
static LexoRankBucket	from(java.lang.String str)
static LexoRankBucket	max()
LexoRankBucket	next()
LexoRankBucket	prev()
static LexoRankBucket	resolve(int bucketId)
static LexoRankBucket	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LexoRankBucket[]	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

BUCKET_0

public static final LexoRankBucket BUCKET_0

BUCKET_1

public static final LexoRankBucket BUCKET_1

BUCKET_2

public static final LexoRankBucket BUCKET_2

Method Detail

values

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

Returns:

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

valueOf

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

resolve

public static LexoRankBucket resolve(int bucketId)

format

public java.lang.String format()

next

public LexoRankBucket next()

prev

public LexoRankBucket prev()

from

public static LexoRankBucket from(java.lang.String str)

max

public static LexoRankBucket max()

Returns:

the largest bucket