se.bjurr.gitchangelog.api

Class GitChangelogApi

java.lang.Object

se.bjurr.gitchangelog.api.GitChangelogApi

public class GitChangelogApi
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ZERO_COMMIT

Method Summary

Modifier and Type	Method and Description
Changelog	getChangelog()
static GitChangelogApi	gitChangelogApiBuilder()
java.lang.String	render()
void	toFile(java.lang.String filePath)
void	toStdout()
GitChangelogApi	withCustomIssues(java.lang.String name, java.lang.String pattern, java.lang.String link)
GitChangelogApi	withFromCommit(java.lang.String fromCommit)
GitChangelogApi	withFromRef(java.lang.String fromBranch)
GitChangelogApi	withFromRepo(java.lang.String fromRepo)
GitChangelogApi	withGithubIssuePattern(java.lang.String githubIssuePattern)
GitChangelogApi	withGithubServer(java.lang.String githubServer)
GitChangelogApi	withIgnoreCommitsWithMesssage(java.lang.String ignoreCommitsIfMessageMatches)
GitChangelogApi	withJiraIssuePattern(java.lang.String jiraIssuePattern)
GitChangelogApi	withJiraServer(java.lang.String jiraServer)
GitChangelogApi	withSettings(java.net.URL url)
GitChangelogApi	withTemplateContent(java.lang.String templateContent)
GitChangelogApi	withTemplatePath(java.lang.String templatePath)
GitChangelogApi	withToCommit(java.lang.String toCommit)
GitChangelogApi	withToRef(java.lang.String toBranch)
GitChangelogApi	withUntaggedName(java.lang.String untaggedName)

Methods inherited from class java.lang.Object

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

Field Detail

ZERO_COMMIT

public static final java.lang.String ZERO_COMMIT

See Also:

Constant Field Values

Method Detail

withSettings

public GitChangelogApi withSettings(java.net.URL url)

gitChangelogApiBuilder

public static GitChangelogApi gitChangelogApiBuilder()

withFromRepo

public GitChangelogApi withFromRepo(java.lang.String fromRepo)

withFromRef

public GitChangelogApi withFromRef(java.lang.String fromBranch)

withToRef

public GitChangelogApi withToRef(java.lang.String toBranch)

getChangelog

public Changelog getChangelog()

withFromCommit

public GitChangelogApi withFromCommit(java.lang.String fromCommit)

withToCommit

public GitChangelogApi withToCommit(java.lang.String toCommit)

withUntaggedName

public GitChangelogApi withUntaggedName(java.lang.String untaggedName)

withJiraIssuePattern

public GitChangelogApi withJiraIssuePattern(java.lang.String jiraIssuePattern)

withJiraServer

public GitChangelogApi withJiraServer(java.lang.String jiraServer)

withIgnoreCommitsWithMesssage

public GitChangelogApi withIgnoreCommitsWithMesssage(java.lang.String ignoreCommitsIfMessageMatches)

withGithubIssuePattern

public GitChangelogApi withGithubIssuePattern(java.lang.String githubIssuePattern)

withGithubServer

public GitChangelogApi withGithubServer(java.lang.String githubServer)

withCustomIssues

public GitChangelogApi withCustomIssues(java.lang.String name,
                                        java.lang.String pattern,
                                        java.lang.String link)

toStdout

public void toStdout()

toFile

public void toFile(java.lang.String filePath)

withTemplatePath

public GitChangelogApi withTemplatePath(java.lang.String templatePath)

withTemplateContent

public GitChangelogApi withTemplateContent(java.lang.String templateContent)

render

public java.lang.String render()