com.atlassian.jgitflow.core

Class GitFlowConfiguration

java.lang.Object

com.atlassian.jgitflow.core.GitFlowConfiguration

public class GitFlowConfiguration
extends Object

Represents the configuration for a git flow project

Instances of this class are usually created internally by initializing a git flow project.

for example: JGitFlow.getOrInit(new File("some dir"));

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	PREFIX_NAMES

Constructor Summary

Constructors

Constructor and Description
GitFlowConfiguration(org.eclipse.jgit.api.Git git) Create a new configuration instance

Method Summary

Methods

Modifier and Type	Method and Description
String	getDevelop()
String	getMaster()
List<String>	getPrefixNames()
String	getPrefixValue(String prefixName)
boolean	gitFlowIsInitialized()
boolean	hasDevelopConfigured()
boolean	hasMasterConfigured()
boolean	hasPrefixConfigured(String prefixName)
boolean	hasPrefixesConfigured()
void	setDevelop(String branchName) Sets the name of the develop branch
void	setMaster(String branchName) Sets the name of the master branch
void	setPrefix(String prefixName, String prefixValue) Sets the value for a given prefix

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX_NAMES

public static final List<String> PREFIX_NAMES

Constructor Detail

GitFlowConfiguration

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

Create a new configuration instance

Parameters:

git - The git instance to use

Method Detail

getDevelop

public String getDevelop()

Returns:

The name of the develop branch

getMaster

public String getMaster()

Returns:

the name of the master branch

setMaster

public void setMaster(String branchName)
               throws JGitFlowIOException

Sets the name of the master branch

Parameters:

branchName -

Throws:

JGitFlowIOException

setDevelop

public void setDevelop(String branchName)
                throws JGitFlowIOException

Sets the name of the develop branch

Parameters:

branchName -

Throws:

JGitFlowIOException

gitFlowIsInitialized

public boolean gitFlowIsInitialized()
                             throws JGitFlowGitAPIException

Returns:

if the current project has been initialized for git flow

Throws:

JGitFlowGitAPIException

hasDevelopConfigured

public boolean hasDevelopConfigured()
                             throws JGitFlowGitAPIException

Returns:

if the local develop branch exists

Throws:

JGitFlowGitAPIException

hasMasterConfigured

public boolean hasMasterConfigured()
                            throws JGitFlowGitAPIException

Returns:

if the local master branch exists

Throws:

JGitFlowGitAPIException

hasPrefixesConfigured

public boolean hasPrefixesConfigured()

Returns:

if all of the prefixes have been configured

getPrefixNames

public List<String> getPrefixNames()

Returns:

A list of all the prefix names

hasPrefixConfigured

public boolean hasPrefixConfigured(String prefixName)

Parameters:

prefixName -

Returns:

If a specific prefix has been configured

getPrefixValue

public String getPrefixValue(String prefixName)

Parameters:

prefixName -

Returns:

The configured value of the given prefix

setPrefix

public void setPrefix(String prefixName,
             String prefixValue)
               throws JGitFlowIOException

Sets the value for a given prefix

Parameters:

prefixName -

prefixValue -

Throws:

JGitFlowIOException