com.atlassian.jgitflow.core

Class JGitFlow

java.lang.Object

com.atlassian.jgitflow.core.JGitFlow

public class JGitFlow
extends Object

Offers a Git Flow API to interact with a git repository.

This class only offers methods to construct so-called command classes. Each command is represented by one command class.
Example: this class offers a featureStart method returning an instance of the FeatureStartCommand class. The FeatureStartCommand class has setters for all the arguments and options. The FeatureStartCommand class also has a call method to actually execute the command.

All mandatory parameters for commands have to be specified in the methods of this class, the optional parameters have to be specified by the setter-methods of the Command class.

Method Summary

Methods

Modifier and Type	Method and Description
FeatureFinishCommand	featureFinish(String name) Returns a command object to finish a feature
FeaturePublishCommand	featurePublish(String name) Returns a command object to publish a feature
FeatureStartCommand	featureStart(String name) Returns a command object to start a feature
static JGitFlow	forceInit(File projectDir) Initializes a project for use with git flow using a default context overriding any existing configuration.
static JGitFlow	forceInit(File projectDir, InitContext context) Initializes a project for use with git flow using a custom context overriding any existing configuration.
static JGitFlow	forceInit(File projectDir, InitContext context, String defaultOriginUrl) Initializes a project for use with git flow using a custom context overriding any existing configuration.
static JGitFlow	forceInit(File projectDir, String defaultOriginUrl) Initializes a project for use with git flow using a default context overriding any existing configuration.
static JGitFlow	get(File projectDir) Gets an existing git flow project and returns a JGitFlow instance
String	getDevelopBranchName() Returns the develop branch name configured for this instance's git flow project
String	getFeatureBranchPrefix() Returns the feature branch prefix configured for this instance's git flow project
String	getHotfixBranchPrefix() Returns the hotfix branch prefix configured for this instance's git flow project
String	getMasterBranchName() Returns the master branch name configured for this instance's git flow project
static JGitFlow	getOrInit(File projectDir) Initializes a project for use with git flow or gets an existing project and returns a JGitFlow instance.
static JGitFlow	getOrInit(File projectDir, InitContext ctx) Initializes a project for use with git flow using a custom context or gets an existing project and returns a JGitFlow instance.
static JGitFlow	getOrInit(File projectDir, InitContext ctx, String defaultOriginUrl) Initializes a project for use with git flow using a custom context or gets an existing project and returns a JGitFlow instance.
static JGitFlow	getOrInit(File projectDir, String defaultOriginUrl) Initializes a project for use with git flow or gets an existing project and returns a JGitFlow instance.
String	getReleaseBranchPrefix() Returns the release branch prefix configured for this instance's git flow project
JGitFlowReporter	getReporter()
String	getSupportBranchPrefix()
String	getVersionTagPrefix() Returns the versiontag prefix configured for this instance's git flow project
org.eclipse.jgit.api.Git	git() Returns the Git instance used by this JGitFlow instance
HotfixFinishCommand	hotfixFinish(String name) Returns a command object to finish a hotfix
HotfixPublishCommand	hotfixPublish(String name) Returns a command object to publish a hotfix
HotfixStartCommand	hotfixStart(String name) Returns a command object to start a hotfix
static JGitFlow	init(File projectDir) Initializes a project for use with git flow and returns a JGitFlow instance.
static JGitFlow	init(File projectDir, InitContext context) Initializes a project for use with git flow using a custom context and returns a JGitFlow instance.
static JGitFlow	init(File projectDir, InitContext context, String defaultOriginUrl) Initializes a project for use with git flow using a custom context and returns a JGitFlow instance.
static JGitFlow	init(File projectDir, String defaultOriginUrl) Initializes a project for use with git flow and returns a JGitFlow instance.
boolean	isInitialized() Tests whether the current project is git flow enabled
static boolean	isInitialized(File dir) Tests whether a project folder is git flow enabled
ReleaseFinishCommand	releaseFinish(String name) Returns a command object to finish a release
ReleasePublishCommand	releasePublish(String name) Returns a command object to publish a release
ReleaseStartCommand	releaseStart(String name) Returns a command object to start a release

Methods inherited from class java.lang.Object

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

Method Detail

init

public static JGitFlow init(File projectDir)
                     throws JGitFlowIOException,
                            AlreadyInitializedException,
                            SameBranchException,
                            JGitFlowGitAPIException

Initializes a project for use with git flow and returns a JGitFlow instance.

This method will throw exceptions if the project has already been initialized

Parameters:

projectDir -

Returns:

Throws:

JGitFlowIOException

AlreadyInitializedException

SameBranchException

JGitFlowGitAPIException

init

public static JGitFlow init(File projectDir,
            String defaultOriginUrl)
                     throws JGitFlowIOException,
                            AlreadyInitializedException,
                            SameBranchException,
                            JGitFlowGitAPIException

Initializes a project for use with git flow and returns a JGitFlow instance.

This method will throw exceptions if the project has already been initialized

Parameters:

projectDir -

Returns:

Throws:

JGitFlowIOException

AlreadyInitializedException

SameBranchException

JGitFlowGitAPIException

init

public static JGitFlow init(File projectDir,
            InitContext context)
                     throws JGitFlowIOException,
                            AlreadyInitializedException,
                            SameBranchException,
                            JGitFlowGitAPIException

Initializes a project for use with git flow using a custom context and returns a JGitFlow instance.

This method will throw exceptions if the project has already been initialized

Parameters:

projectDir -

context -

Returns:

Throws:

JGitFlowIOException

AlreadyInitializedException

SameBranchException

JGitFlowGitAPIException

init

public static JGitFlow init(File projectDir,
            InitContext context,
            String defaultOriginUrl)
                     throws JGitFlowIOException,
                            AlreadyInitializedException,
                            SameBranchException,
                            JGitFlowGitAPIException

Initializes a project for use with git flow using a custom context and returns a JGitFlow instance.

This method will throw exceptions if the project has already been initialized

Parameters:

projectDir -

context -

Returns:

Throws:

JGitFlowIOException

AlreadyInitializedException

SameBranchException

JGitFlowGitAPIException

forceInit

public static JGitFlow forceInit(File projectDir)
                          throws JGitFlowIOException,
                                 AlreadyInitializedException,
                                 SameBranchException,
                                 JGitFlowGitAPIException

Initializes a project for use with git flow using a default context overriding any existing configuration.

Parameters:

projectDir -

Returns:

Throws:

JGitFlowIOException

AlreadyInitializedException

SameBranchException

JGitFlowGitAPIException

forceInit

public static JGitFlow forceInit(File projectDir,
                 String defaultOriginUrl)
                          throws JGitFlowIOException,
                                 AlreadyInitializedException,
                                 SameBranchException,
                                 JGitFlowGitAPIException

Initializes a project for use with git flow using a default context overriding any existing configuration.

Parameters:

projectDir -

Returns:

Throws:

JGitFlowIOException

AlreadyInitializedException

SameBranchException

JGitFlowGitAPIException

forceInit

public static JGitFlow forceInit(File projectDir,
                 InitContext context)
                          throws JGitFlowIOException,
                                 AlreadyInitializedException,
                                 SameBranchException,
                                 JGitFlowGitAPIException

Initializes a project for use with git flow using a custom context overriding any existing configuration.

Parameters:

projectDir -

context -

Returns:

Throws:

JGitFlowIOException

AlreadyInitializedException

SameBranchException

JGitFlowGitAPIException

forceInit

public static JGitFlow forceInit(File projectDir,
                 InitContext context,
                 String defaultOriginUrl)
                          throws JGitFlowIOException,
                                 AlreadyInitializedException,
                                 SameBranchException,
                                 JGitFlowGitAPIException

Initializes a project for use with git flow using a custom context overriding any existing configuration.

Parameters:

projectDir -

context -

Returns:

Throws:

JGitFlowIOException

AlreadyInitializedException

SameBranchException

JGitFlowGitAPIException

get

public static JGitFlow get(File projectDir)
                    throws JGitFlowIOException

Gets an existing git flow project and returns a JGitFlow instance

Parameters:

projectDir -

Returns:

Throws:

JGitFlowIOException

getOrInit

public static JGitFlow getOrInit(File projectDir)
                          throws JGitFlowIOException,
                                 AlreadyInitializedException,
                                 SameBranchException,
                                 JGitFlowGitAPIException

Initializes a project for use with git flow or gets an existing project and returns a JGitFlow instance.

Parameters:

projectDir -

Returns:

Throws:

JGitFlowIOException

AlreadyInitializedException

SameBranchException

JGitFlowGitAPIException

getOrInit

public static JGitFlow getOrInit(File projectDir,
                 String defaultOriginUrl)
                          throws JGitFlowIOException,
                                 AlreadyInitializedException,
                                 SameBranchException,
                                 JGitFlowGitAPIException

Initializes a project for use with git flow or gets an existing project and returns a JGitFlow instance.

Parameters:

projectDir -

Returns:

Throws:

JGitFlowIOException

AlreadyInitializedException

SameBranchException

JGitFlowGitAPIException

getOrInit

public static JGitFlow getOrInit(File projectDir,
                 InitContext ctx)
                          throws JGitFlowIOException,
                                 AlreadyInitializedException,
                                 SameBranchException,
                                 JGitFlowGitAPIException

Initializes a project for use with git flow using a custom context or gets an existing project and returns a JGitFlow instance.

Parameters:

projectDir -

ctx -

Returns:

Throws:

JGitFlowIOException

AlreadyInitializedException

SameBranchException

JGitFlowGitAPIException

getOrInit

public static JGitFlow getOrInit(File projectDir,
                 InitContext ctx,
                 String defaultOriginUrl)
                          throws JGitFlowIOException,
                                 AlreadyInitializedException,
                                 SameBranchException,
                                 JGitFlowGitAPIException

Initializes a project for use with git flow using a custom context or gets an existing project and returns a JGitFlow instance.

Parameters:

projectDir -

ctx -

Returns:

Throws:

JGitFlowIOException

AlreadyInitializedException

SameBranchException

JGitFlowGitAPIException

isInitialized

public static boolean isInitialized(File dir)

Tests whether a project folder is git flow enabled

Parameters:

dir -

Returns:

isInitialized

public boolean isInitialized()

Tests whether the current project is git flow enabled

Returns:

featureStart

public FeatureStartCommand featureStart(String name)

Returns a command object to start a feature

Parameters:

name -

Returns:

a FeatureStartCommand

featureFinish

public FeatureFinishCommand featureFinish(String name)

Returns a command object to finish a feature

Parameters:

name -

Returns:

a FeatureFinishCommand

featurePublish

public FeaturePublishCommand featurePublish(String name)

Returns a command object to publish a feature

Parameters:

name -

Returns:

a FeaturePublishCommand

releaseStart

public ReleaseStartCommand releaseStart(String name)

Returns a command object to start a release

Parameters:

name -

Returns:

a ReleaseStartCommand

releaseFinish

public ReleaseFinishCommand releaseFinish(String name)

Returns a command object to finish a release

Parameters:

name -

Returns:

a ReleaseFinishCommand

releasePublish

public ReleasePublishCommand releasePublish(String name)

Returns a command object to publish a release

Parameters:

name -

Returns:

a ReleasePublishCommand

hotfixStart

public HotfixStartCommand hotfixStart(String name)

Returns a command object to start a hotfix

Parameters:

name -

Returns:

a HotfixStartCommand

hotfixFinish

public HotfixFinishCommand hotfixFinish(String name)

Returns a command object to finish a hotfix

Parameters:

name -

Returns:

a HotfixFinishCommand

hotfixPublish

public HotfixPublishCommand hotfixPublish(String name)

Returns a command object to publish a hotfix

Parameters:

name -

Returns:

a HotfixPublishCommand

git

public org.eclipse.jgit.api.Git git()

Returns the Git instance used by this JGitFlow instance

Returns:

getMasterBranchName

public String getMasterBranchName()

Returns the master branch name configured for this instance's git flow project

Returns:

getDevelopBranchName

public String getDevelopBranchName()

Returns the develop branch name configured for this instance's git flow project

Returns:

getFeatureBranchPrefix

public String getFeatureBranchPrefix()

Returns the feature branch prefix configured for this instance's git flow project

Returns:

getReleaseBranchPrefix

public String getReleaseBranchPrefix()

Returns the release branch prefix configured for this instance's git flow project

Returns:

getHotfixBranchPrefix

public String getHotfixBranchPrefix()

Returns the hotfix branch prefix configured for this instance's git flow project

Returns:

getSupportBranchPrefix

public String getSupportBranchPrefix()

getVersionTagPrefix

public String getVersionTagPrefix()

Returns the versiontag prefix configured for this instance's git flow project

Returns:

getReporter

public JGitFlowReporter getReporter()