org.docascode.api.core

Class DocAsCodeRepository

java.lang.Object

org.docascode.api.listener.APIEventListener

org.docascode.api.core.DocAsCodeRepository

All Implemented Interfaces:

EventListener

public class DocAsCodeRepository
extends APIEventListener

Constructor Summary

Constructors

Constructor and Description
DocAsCodeRepository(org.eclipse.jgit.lib.Repository repo) A DocAsCodeRepository constructor

Method Summary

Modifier and Type	Method and Description
ChronoRepository	chrono() A Chrono Repository Controller for this DocAsCode repository.
File	getChronoXML() The chrono.xml file.
File	getDeliveryProperties() The delivery.properties file for this repository.
File	getDeliveryXML()
Map<File,Map<String,String>>	getDictionnaries()
File	getDocAsCodeDir() The .docascode directory.
File	getProjectSettingsFile() The Maven project settings file for this DocAsCode repository.
File	getTmpDir() The temporary working directory for this DocAsCode repository.
String	getVersion() The version of this DocAsCode repository.
File	getWorkTree() The workTree of the current DocAsCode/Git Repository.
GitRepository	git() A Git Repository Controller for this DocAsCode repository.
MvnRepository	mvn() A Maven Repository Controller for this DocAsCode repository.
String	relativize(File file) Resolve file path relatively to the worktree of this DocAsCode repository.
String	substitute(File file, String string)

Methods inherited from class org.docascode.api.listener.APIEventListener

addListener, fireEvent, log, progress

Methods inherited from class java.lang.Object

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

Constructor Detail

DocAsCodeRepository

public DocAsCodeRepository(org.eclipse.jgit.lib.Repository repo)
                    throws IOException

A DocAsCodeRepository constructor

Parameters:

repo - The base Git Repository.

Throws:

IOException

Method Detail

getWorkTree

public File getWorkTree()

The workTree of the current DocAsCode/Git Repository.

substitute

public String substitute(File file,
                         String string)
                  throws DocAsCodeException

Throws:

DocAsCodeException

getDictionnaries

public Map<File,Map<String,String>> getDictionnaries()

mvn

public MvnRepository mvn()

A Maven Repository Controller for this DocAsCode repository.

Returns:

the MvnRepository

chrono

public ChronoRepository chrono()

A Chrono Repository Controller for this DocAsCode repository.

Returns:

the ChronoRepository

getDeliveryProperties

public File getDeliveryProperties()

The delivery.properties file for this repository.

Returns:

the delivery.properties file.

getDocAsCodeDir

public File getDocAsCodeDir()

The .docascode directory.

getChronoXML

public File getChronoXML()

The chrono.xml file.

getDeliveryXML

public File getDeliveryXML()

getProjectSettingsFile

public File getProjectSettingsFile()

The Maven project settings file for this DocAsCode repository.

Returns:

the Maven project file.

relativize

public String relativize(File file)

Resolve file path relatively to the worktree of this DocAsCode repository. Paths are returned in Unix styles.

Parameters:

file - the file to resolve.

Returns:

the resolved path.

getTmpDir

public File getTmpDir()

The temporary working directory for this DocAsCode repository.

Returns:

the temporary working directory.

getVersion

public String getVersion()
                  throws DocAsCodeException

The version of this DocAsCode repository. Usually this version is set through an init or upgrade

Returns:

this DocAsCode repository version

Throws:

DocAsCodeException

git

public GitRepository git()

A Git Repository Controller for this DocAsCode repository.

Returns:

the GitRepository.