net.praqma.clearcase.ucm.utils

Class BuildNumber

java.lang.Object

net.praqma.clearcase.Cool

net.praqma.clearcase.ucm.utils.BuildNumber

public class BuildNumber
extends Cool

Field Summary

Fields

Modifier and Type	Field and Description
static String	__BUILD_NUMBER_FILE
static String	__BUILD_NUMBER_MAJOR
static String	__BUILD_NUMBER_MINOR
static String	__BUILD_NUMBER_PATCH
static String	__BUILD_NUMBER_SEQUENCE
static int	ALL_ATTRIBUTES
static int	ATTRIBUTE_MAJOR
static int	ATTRIBUTE_MINOR
static int	ATTRIBUTE_PATCH
static int	ATTRIBUTE_SEQUENCE

Fields inherited from class net.praqma.clearcase.Cool

delim, filesep, filesepChar, linesep, qfs, qfsor

Constructor Summary

Constructors

Constructor and Description
BuildNumber()

Method Summary

Modifier and Type	Method and Description
static net.praqma.util.structure.Tuple<Baseline,String[]>	createBuildNumber(String baseline, Component component, File view)
static String	getBuildNumber(Project project) This method returns the new build number for a Baseline.
static Integer	getNextBuildSequence(Project project) Given a Project, its top level Components sequence number is retrieved, incremented, stored and returned.
static String[]	isBuildNumber(Baseline baseline)
static int	isValidUCMBuildNumber(Project project) Verify that the project has valid UCM build number attributes
static int	stampFromComponent(Component component, File dir, String major, String minor, String patch, String sequence, boolean ignoreErrors)
static int	stampIntoCode(Baseline baseline)
static int	stampIntoCode(Baseline baseline, File dir)
static int	stampIntoCode(Baseline baseline, File dir, boolean ignoreErrors)
static int	stampIntoCode(File file, String major, String minor, String patch, String sequence)

Methods inherited from class net.praqma.clearcase.Cool

getOS

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

__BUILD_NUMBER_MAJOR

public static final String __BUILD_NUMBER_MAJOR

See Also:

Constant Field Values

__BUILD_NUMBER_MINOR

public static final String __BUILD_NUMBER_MINOR

See Also:

Constant Field Values

__BUILD_NUMBER_PATCH

public static final String __BUILD_NUMBER_PATCH

See Also:

Constant Field Values

__BUILD_NUMBER_SEQUENCE

public static final String __BUILD_NUMBER_SEQUENCE

See Also:

Constant Field Values

__BUILD_NUMBER_FILE

public static final String __BUILD_NUMBER_FILE

See Also:

Constant Field Values

ALL_ATTRIBUTES

public static final int ALL_ATTRIBUTES

See Also:

Constant Field Values

ATTRIBUTE_MAJOR

public static final int ATTRIBUTE_MAJOR

See Also:

Constant Field Values

ATTRIBUTE_MINOR

public static final int ATTRIBUTE_MINOR

See Also:

Constant Field Values

ATTRIBUTE_PATCH

public static final int ATTRIBUTE_PATCH

See Also:

Constant Field Values

ATTRIBUTE_SEQUENCE

public static final int ATTRIBUTE_SEQUENCE

See Also:

Constant Field Values

Constructor Detail

BuildNumber

public BuildNumber()

Method Detail

isBuildNumber

public static String[] isBuildNumber(Baseline baseline)
                              throws BuildNumberException

Throws:

BuildNumberException

createBuildNumber

public static net.praqma.util.structure.Tuple<Baseline,String[]> createBuildNumber(String baseline,
                                                                                   Component component,
                                                                                   File view)
                                                                            throws BuildNumberException,
                                                                                   UnableToInitializeEntityException,
                                                                                   UnableToCreateEntityException,
                                                                                   NothingNewException

Throws:

BuildNumberException

UnableToInitializeEntityException

UnableToCreateEntityException

NothingNewException

stampFromComponent

public static int stampFromComponent(Component component,
                                     File dir,
                                     String major,
                                     String minor,
                                     String patch,
                                     String sequence,
                                     boolean ignoreErrors)
                              throws HyperlinkException,
                                     UnableToInitializeEntityException,
                                     BuildNumberException,
                                     IOException

Throws:

HyperlinkException

UnableToInitializeEntityException

BuildNumberException

IOException

stampIntoCode

public static int stampIntoCode(Baseline baseline)
                         throws BuildNumberException,
                                UnableToLoadEntityException,
                                UnableToCreateEntityException,
                                UCMEntityNotFoundException,
                                HyperlinkException,
                                IOException,
                                UnableToGetEntityException,
                                UnableToInitializeEntityException

Throws:

BuildNumberException

UnableToLoadEntityException

UnableToCreateEntityException

UCMEntityNotFoundException

HyperlinkException

IOException

UnableToGetEntityException

UnableToInitializeEntityException

stampIntoCode

public static int stampIntoCode(Baseline baseline,
                                File dir)
                         throws BuildNumberException,
                                HyperlinkException,
                                UnableToInitializeEntityException,
                                IOException

Throws:

BuildNumberException

HyperlinkException

UnableToInitializeEntityException

IOException

stampIntoCode

public static int stampIntoCode(Baseline baseline,
                                File dir,
                                boolean ignoreErrors)
                         throws BuildNumberException,
                                HyperlinkException,
                                UnableToInitializeEntityException,
                                IOException

Throws:

BuildNumberException

HyperlinkException

UnableToInitializeEntityException

IOException

stampIntoCode

public static int stampIntoCode(File file,
                                String major,
                                String minor,
                                String patch,
                                String sequence)
                         throws IOException

Throws:

IOException

getNextBuildSequence

public static Integer getNextBuildSequence(Project project)
                                    throws NoSingleTopComponentException,
                                           UnableToInitializeEntityException,
                                           UnableToListAttributesException,
                                           BuildNumberException,
                                           UnableToSetAttributeException

Given a Project, its top level Components sequence number is retrieved, incremented, stored and returned.

Parameters:

project - A UCM Project

Returns:

Integer

Throws:

UnableToInitializeEntityException - Thrown when ClearCase reports errors

UnableToSetAttributeException - Thrown when ClearCase reports errors

BuildNumberException - Thrown when ClearCase reports errors

UnableToListAttributesException - Thrown when ClearCase reports errors

NoSingleTopComponentException - Thrown when ClearCase reports errors

isValidUCMBuildNumber

public static int isValidUCMBuildNumber(Project project)
                                 throws NoSingleTopComponentException,
                                        UnableToInitializeEntityException,
                                        UnableToListAttributesException

Verify that the project has valid UCM build number attributes

Parameters:

project - The UCM project to verify

Returns:

A flag determining the attributes present

Throws:

NoSingleTopComponentException - Thrown error

UnableToInitializeEntityException - Thrown error

UnableToListAttributesException - Thrown error

getBuildNumber

public static String getBuildNumber(Project project)
                             throws UnableToListAttributesException,
                                    BuildNumberException,
                                    NoSingleTopComponentException,
                                    UnableToInitializeEntityException,
                                    UnableToSetAttributeException

This method returns the new build number for a Baseline.

Parameters:

project - The project to get the build number from

Returns:

String

Throws:

UnableToListAttributesException - Error

BuildNumberException - Error

UnableToSetAttributeException - Error

UnableToInitializeEntityException - Error

NoSingleTopComponentException - Error