Package ch.tocco.nice2.dbrefactoring.api

Class ChangesetId

java.lang.Object

ch.tocco.nice2.dbrefactoring.api.ChangesetId

public final class ChangesetId
extends Object

The id attribute given in a changeset of a module must conform to the following convention:

   [name] / [nice2Version]
 

where

• name is some arbitary name describing the changeset
• nice2Version the version of nice2 application this change was introduced

While processing the changelog files, the module name is appended to the id of the changeset to avoid unique clashes between modules.

This interface gives access to the parts of the id of the changeset.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGESET_ID_REGEX
static final String	CHANGESET_NAME_REGEX
static final Pattern	CHANGESET_PATTERN
static final char	SEPARATOR

Method Summary

Modifier and Type	Method	Description
static ChangesetId	create(String name, Nice2Version version, @Nullable String moduleName)
static ChangesetId	createRandomId(String name, Nice2Version version, @Nullable String moduleName)
boolean	equals(Object o)
@Nullable String	getModuleName()	Returns the name of the nice2 module that contributed this changeset.
String	getName()	The name part of the changeset id.
Nice2Version	getNice2Version()	Returns the part of the changeset id the represents the nice2 version where this changeset was introduced.
int	hashCode()
static ChangesetId	parseString(String changesetId)
static ChangesetId	parseString(String changesetId, String moduleName)
String	toChangesetId()	Returns the final string which is used as the id attribute for this changeset in the global changlog file.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

SEPARATOR

public static final char SEPARATOR

See Also:

• Constant Field Values

CHANGESET_NAME_REGEX

@RegExp
public static final String CHANGESET_NAME_REGEX

See Also:

• Constant Field Values

CHANGESET_ID_REGEX

@RegExp
public static final String CHANGESET_ID_REGEX

See Also:

• Constant Field Values

CHANGESET_PATTERN

public static final Pattern CHANGESET_PATTERN

Method Details

create

public static ChangesetId create(String name,
 Nice2Version version,
 @Nullable
 @Nullable String moduleName)

createRandomId

public static ChangesetId createRandomId(String name,
 Nice2Version version,
 @Nullable
 @Nullable String moduleName)

parseString

public static ChangesetId parseString(String changesetId,
 String moduleName)
                               throws DbRefactoringException

Throws:

DbRefactoringException

parseString

public static ChangesetId parseString(String changesetId)
                               throws DbRefactoringException

Throws:

DbRefactoringException

getModuleName

@Nullable
public @Nullable String getModuleName()

Returns the name of the nice2 module that contributed this changeset.

getName

public String getName()

The name part of the changeset id. The name is just some string invented by the person who introduced the changeset.

getNice2Version

public Nice2Version getNice2Version()

Returns the part of the changeset id the represents the nice2 version where this changeset was introduced.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toChangesetId

public String toChangesetId()

Returns the final string which is used as the id attribute for this changeset in the global changlog file.

toString

public String toString()

Overrides:

toString in class Object