Package org.codehaus.mojo.versions.api

Enum Segment

java.lang.Object

java.lang.Enum<Segment>

org.codehaus.mojo.versions.api.Segment

All Implemented Interfaces:

Serializable, Comparable<Segment>

public enum Segment
extends Enum<Segment>
implements Comparable<Segment>

Indicates the segment along with its 0-based index

Author:

Andrzej Jarmoniuk

Enum Constant Summary

Enum Constants

Enum Constant	Description
INCREMENTAL
MAJOR
MINOR
SUBINCREMENTAL

Method Summary

Modifier and Type	Method	Description
boolean	isMajorTo(Segment other)	Returns true if the given segment is more major than the other
static Segment	majorTo(Segment other)	Creates a segment that has a greater scope than the given segment or null if the segment is already MAJOR
static Segment	minorTo(Segment other)	Creates a segment that has a lesser scope than the given segment
static Segment	of(int index)
String	toString()
int	value()	Returns the 0-based sendex index
static Segment	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Segment[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Details

MAJOR

public static final Segment MAJOR

MINOR

public static final Segment MINOR

INCREMENTAL

public static final Segment INCREMENTAL

SUBINCREMENTAL

public static final Segment SUBINCREMENTAL

Method Details

values

public static Segment[] 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 Segment 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

value

public int value()

Returns the 0-based sendex index

Returns:

0-based sendex index

of

public static Segment of(int index)

majorTo

public static Segment majorTo(Segment other)

Creates a segment that has a greater scope than the given segment or null if the segment is already MAJOR

Parameters:

other - segment that the new segment is to be based on

Returns:

that has a greater scope than the given segment or null if the segment is already MAJOR

minorTo

public static Segment minorTo(Segment other)

Creates a segment that has a lesser scope than the given segment

Parameters:

other - segment that the new segment is to be based on

Returns:

that has a lesser scope than the given segment

isMajorTo

public boolean isMajorTo(Segment other)

Returns true if the given segment is more major than the other

Parameters:

other - other segment to compare

Returns:

true if the given segment is more major

toString

public String toString()

Overrides:

toString in class Enum<Segment>