tecgraf.javautils.version

Class VersionNumber

java.lang.Object

tecgraf.javautils.version.VersionNumber

All Implemented Interfaces:

Serializable, Comparable<VersionNumber>

public class VersionNumber
extends Object
implements Comparable<VersionNumber>, Serializable

Utilit�rio para tratamento vers�es de elementos de programa��o: classes, sistemas, arquivos e/ou qualquer outra entidade.

Author:

Tecgraf/PUC-Rio

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static VersionNumber	LIMIT_VERSION Maior vers�o poss�vel de existir.
static int	MAX_PART Maior valor suportado para itens (partes) de vers�o: major, minor ou patch
static VersionNumber	ZERO_VERSION Menor vers�o poss�vel de existir.

Constructor Summary

Constructors

Constructor and Description
VersionNumber(int major, int minor, int patch) Construtor

Method Summary

Modifier and Type	Method and Description
void	add() M�todo para ajustar uma vers�o para a poss�vel pr�xima (eventualmente n�o existente); devendo ser usado basicamente para forma��o de algoritmos de l�gica de vers�o.
void	check() Check do objeto levantando exec��o caso os atributos internos estejam inconsistentes (n�meros major, minor e patch).
protected VersionNumber	clone()
int	compareTo(VersionNumber version)
boolean	equals(Object obj)
void	freeze() Congela altera��o no dado.
static VersionNumber	fromString(String text) Monta uma vers�o com base em texto.
static VersionNumber	fromStringAsBranch(String text) Monta uma vers�o com base em texto de tag.
static VersionNumber	fromStringAsTag(String text) Monta uma vers�o com base em texto de tag.
int	getMajor() Major.
int	getMinor() Minor.
int	getPatch() Patch.
int	hashCode()
void	increment(int deltaMajor, int deltaMinor, int deltaPatch) Ajusta para uma nova vers�o (com incremento de major); que N�O faz altera��es dependentes entre as partes.
void	invalidate() Torna dado inv�lido.
boolean	isValid() Indica se dado � valido (ou foi inicializado).
static boolean	isValidPart(int part) Indica validade de uma parte de vers�o.
void	setMajor(int major) Ajusta o valor de: marcador de vers�o (ver major).
void	setMinor(int minor) Ajusta o valor de: marcador de vers�o (ver minor).
void	setPatch(int patch) Ajusta o valor de: marcador de vers�o (ver patch).
String	toString()
String	toStringAsBranch() Retorna um identificador da vers�o.
String	toStringAsTag() Retorna um identificador da vers�o.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MAX_PART

public static final int MAX_PART

Maior valor suportado para itens (partes) de vers�o: major, minor ou patch

See Also:

Constant Field Values

ZERO_VERSION

public static final VersionNumber ZERO_VERSION

Menor vers�o poss�vel de existir.

LIMIT_VERSION

public static final VersionNumber LIMIT_VERSION

Maior vers�o poss�vel de existir.

Constructor Detail

VersionNumber

public VersionNumber(int major,
                     int minor,
                     int patch)

Construtor

Parameters:

major - major

minor - minor

patch - patch

Method Detail

fromString

public static VersionNumber fromString(String text)

Monta uma vers�o com base em texto.

Parameters:

text - texto

Returns:

versão ou null no caso de falha de formatação do texto

fromStringAsBranch

public static VersionNumber fromStringAsBranch(String text)

Monta uma vers�o com base em texto de tag.

Parameters:

text - texto

Returns:

versão ou null no caso de falha de formatação do texto

fromStringAsTag

public static VersionNumber fromStringAsTag(String text)

Monta uma vers�o com base em texto de tag.

Parameters:

text - texto

Returns:

vers�o

isValidPart

public static boolean isValidPart(int part)

Indica validade de uma parte de vers�o.

Parameters:

part - parte

Returns:

indicativo

add

public void add()

M�todo para ajustar uma vers�o para a poss�vel pr�xima (eventualmente n�o existente); devendo ser usado basicamente para forma��o de algoritmos de l�gica de vers�o.

check

public void check()

Check do objeto levantando exec��o caso os atributos internos estejam inconsistentes (n�meros major, minor e patch).

clone

protected VersionNumber clone()

Overrides:

clone in class Object

compareTo

public int compareTo(VersionNumber version)

Specified by:

compareTo in interface Comparable<VersionNumber>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

freeze

public void freeze()

Congela altera��o no dado.

getMajor

public int getMajor()

Major.

Returns:

valor

getMinor

public int getMinor()

Minor.

Returns:

valor

getPatch

public int getPatch()

Patch.

Returns:

o valor

hashCode

public int hashCode()

Overrides:

hashCode in class Object

increment

public void increment(int deltaMajor,
                      int deltaMinor,
                      int deltaPatch)

Ajusta para uma nova vers�o (com incremento de major); que N�O faz altera��es dependentes entre as partes.

Parameters:

deltaMajor - incremento major (podendo ser negativo)

deltaMinor - incremento minor (podendo ser negativo)

deltaPatch - incremento patch (podendo ser negativo)

invalidate

public void invalidate()

Torna dado inv�lido.

isValid

public boolean isValid()

Indica se dado � valido (ou foi inicializado).

Returns:

indicativo

setMajor

public void setMajor(int major)

Ajusta o valor de: marcador de vers�o (ver major).

Parameters:

major - o novo valor a ser ajustado

setMinor

public void setMinor(int minor)

Ajusta o valor de: marcador de vers�o (ver minor).

Parameters:

minor - o novo valor a ser ajustado

setPatch

public void setPatch(int patch)

Ajusta o valor de: marcador de vers�o (ver patch).

Parameters:

patch - o novo valor a ser ajustado

toString

public String toString()

Overrides:

toString in class Object

toStringAsBranch

public final String toStringAsBranch()

Retorna um identificador da vers�o.

Returns:

texto que pode ser usado como identificador.

toStringAsTag

public String toStringAsTag()

Retorna um identificador da vers�o.

Returns:

texto que pode ser usado como identificador.