com.atlassian.jgitflow.core

Class JGitFlowInitCommand

java.lang.Object

com.atlassian.jgitflow.core.JGitFlowInitCommand

All Implemented Interfaces:

Callable<JGitFlow>

public class JGitFlowInitCommand
extends Object
implements Callable<JGitFlow>

Initializes a project for use with git flow

Examples:

Initialize with the defaults or throw an exception if it's already initialized

 JGitFlow flow = JGitFlow.init(new File("some dir"));
 

Initialize with the defaults or return the instance if it's already initialized

 JGitFlow flow = JGitFlow.getOrInit(new File("some dir"));
 

Initialize with custom overrides or return the instance if it's already initialized

 InitContext ctx = new InitContext();
 ctx.setMaster("GA");

 JGitFlow flow = JGitFlow.getOrInit(new File("some dir"), ctx);
 

Initialize with custom overrides replacing any existing configuration

 InitContext ctx = new InitContext();
 ctx.setMaster("GA");

 JGitFlow flow = JGitFlow.forceInit(new File("some dir"), ctx);
 

Constructor Summary

Constructors

Constructor and Description
JGitFlowInitCommand() Create a new init command instance.

Method Summary

Methods

Modifier and Type	Method and Description
JGitFlow	call()
JGitFlowInitCommand	setDefaultOriginUrl(String defaultOriginUrl)
JGitFlowInitCommand	setDirectory(File directory) Sets the project root folder
JGitFlowInitCommand	setForce(boolean force) Whether to override the current configuration
JGitFlowInitCommand	setInitContext(InitContext context) Set the initialization context

Methods inherited from class java.lang.Object

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

Constructor Detail

JGitFlowInitCommand

public JGitFlowInitCommand()

Create a new init command instance.

An instance of this class is usually obtained by calling one of the static JGitFlow init methods

Method Detail

call

public JGitFlow call()
              throws JGitFlowIOException,
                     JGitFlowGitAPIException,
                     AlreadyInitializedException,
                     SameBranchException

Specified by:

call in interface Callable<JGitFlow>

Returns:

A JGitFlow instance

Throws:

JGitFlowIOException

JGitFlowGitAPIException

AlreadyInitializedException

SameBranchException

setDirectory

public JGitFlowInitCommand setDirectory(File directory)

Sets the project root folder

Parameters:

directory -

Returns:

this

setInitContext

public JGitFlowInitCommand setInitContext(InitContext context)

Set the initialization context

Parameters:

context -

Returns:

this

setForce

public JGitFlowInitCommand setForce(boolean force)

Whether to override the current configuration

Parameters:

force - true to override, false(default) otherwise

Returns:

this

setDefaultOriginUrl

public JGitFlowInitCommand setDefaultOriginUrl(String defaultOriginUrl)