Package net.kyori.indra.git.internal

Class IndraGitExtensionImpl

java.lang.Object

net.kyori.indra.git.internal.IndraGitExtensionImpl

All Implemented Interfaces:

IndraGitExtension

public class IndraGitExtensionImpl
extends Object
implements IndraGitExtension

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndraGitExtensionImpl.QueryBranch
static class	IndraGitExtensionImpl.QueryCommit
static class	IndraGitExtensionImpl.QueryDescribe
static class	IndraGitExtensionImpl.QueryHeadTag
static class	IndraGitExtensionImpl.QueryTags

Field Summary

Fields inherited from interface net.kyori.indra.git.IndraGitExtension

MANIFEST_ATTRIBUTE_GIT_BRANCH, MANIFEST_ATTRIBUTE_GIT_COMMIT

Constructor Summary

Constructors

Constructor	Description
IndraGitExtensionImpl(org.gradle.api.provider.ProviderFactory providers, File rootDir, File projectDir, String displayName)

Method Summary

Modifier and Type	Method	Description
@NotNull org.gradle.api.provider.Provider<org.eclipse.jgit.lib.Ref>	branch()	Get an object pointing to the current branch.
@NotNull org.gradle.api.provider.Provider<String>	branchName()	Get the name of the current branch.
@NotNull org.gradle.api.provider.Provider<org.eclipse.jgit.lib.ObjectId>	commit()	Get the ID of the current commit.
@NotNull org.gradle.api.provider.Provider<String>	describe()	Get a git describe string for the project's repository.
@Nullable org.eclipse.jgit.api.Git	git()
@NotNull org.gradle.api.provider.Provider<org.eclipse.jgit.lib.Ref>	headTag()	Get the tag pointing to the commit checked out as HEAD.
static @Nullable org.eclipse.jgit.lib.Ref	headTag(org.eclipse.jgit.api.Git git)
boolean	isPresent()	Get if a git repository is present.
<V, P extends RepositoryValueSource.Parameters, S extends RepositoryValueSource<V, P>> org.gradle.api.provider.Provider<V>	repositoryValue(Class<S> valueSource, org.gradle.api.Action<? super org.gradle.api.provider.ValueSourceSpec<P>> configureAction)	Create a provider which uses a value from a git repository.
@NotNull org.gradle.api.provider.Provider<? extends List<? extends org.eclipse.jgit.lib.Ref>>	tags()	Get all tags created on this repository.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.kyori.indra.git.IndraGitExtension

applyVcsInformationToManifest, repositoryValue

Constructor Details

IndraGitExtensionImpl

@Inject
public IndraGitExtensionImpl(org.gradle.api.provider.ProviderFactory providers,
 File rootDir,
 File projectDir,
 String displayName)

Method Details

isPresent

public boolean isPresent()

Description copied from interface: IndraGitExtension

Get if a git repository is present.

Specified by:

isPresent in interface IndraGitExtension

Returns:

whether or not a git repository is present for the current project.

git

@VisibleForTesting
@Nullable
public @Nullable org.eclipse.jgit.api.Git git()

repositoryValue

public <V,
P extends RepositoryValueSource.Parameters,
S extends RepositoryValueSource<V,
P>>
org.gradle.api.provider.Provider<V> repositoryValue(Class<S> valueSource,
 org.gradle.api.Action<? super org.gradle.api.provider.ValueSourceSpec<P>> configureAction)

Description copied from interface: IndraGitExtension

Create a provider which uses a value from a git repository.

Specified by:

repositoryValue in interface IndraGitExtension

Type Parameters:

V - the value type

P - the value source type

Parameters:

valueSource - the value source type

configureAction - an action to configure any additional parameters on the value source

Returns:

the value provider

tags

@NotNull
public @NotNull org.gradle.api.provider.Provider<? extends List<? extends org.eclipse.jgit.lib.Ref>> tags()

Description copied from interface: IndraGitExtension

Get all tags created on this repository.

Specified by:

tags in interface IndraGitExtension

Returns:

the tags on this repository, or an empty list if this project is not in a git repository

headTag

@Nullable
public static @Nullable org.eclipse.jgit.lib.Ref headTag(org.eclipse.jgit.api.Git git)

headTag

@NotNull
public @NotNull org.gradle.api.provider.Provider<org.eclipse.jgit.lib.Ref> headTag()

Description copied from interface: IndraGitExtension

Get the tag pointing to the commit checked out as HEAD.

Specified by:

headTag in interface IndraGitExtension

Returns:

the tag at HEAD, or null if the project is not in a git repository or is not checked out to a tag

describe

@NotNull
public @NotNull org.gradle.api.provider.Provider<String> describe()

Description copied from interface: IndraGitExtension

Get a git describe string for the project's repository.

The result will be equivalent to the result of executing git describe --tags --long

Specified by:

describe in interface IndraGitExtension

Returns:

the describe string, or null if this project is not in a git repository or if there are no tags in the project's history

branchName

@NotNull
public @NotNull org.gradle.api.provider.Provider<String> branchName()

Description copied from interface: IndraGitExtension

Get the name of the current branch.

Specified by:

branchName in interface IndraGitExtension

Returns:

the name of the active branch, or null if the project is not in a git repository or is checked out to a detached HEAD.

branch

@NotNull
public @NotNull org.gradle.api.provider.Provider<org.eclipse.jgit.lib.Ref> branch()

Description copied from interface: IndraGitExtension

Get an object pointing to the current branch.

Specified by:

branch in interface IndraGitExtension

Returns:

the active branch, or null if the project is not in a git repository or is checked out to a detached HEAD.

commit

@NotNull
public @NotNull org.gradle.api.provider.Provider<org.eclipse.jgit.lib.ObjectId> commit()

Description copied from interface: IndraGitExtension

Get the ID of the current commit.

Specified by:

commit in interface IndraGitExtension

Returns:

the commit id, or null if the project is not in a git repository or has not had its initial commit