Package org.openrewrite.marker

Class GitProvenance

java.lang.Object

org.openrewrite.marker.GitProvenance

All Implemented Interfaces:

Marker

public class GitProvenance
extends Object
implements Marker

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GitProvenance.AutoCRLF
static class	GitProvenance.Committer
static enum	GitProvenance.EOL

Constructor Summary

Constructors

Constructor	Description
GitProvenance(UUID id, @Nullable String origin, @Nullable String branch, @Nullable String change, @Nullable GitProvenance.AutoCRLF autocrlf, @Nullable GitProvenance.EOL eol, @Nullable List<GitProvenance.Committer> committers)

Method Summary

Modifier and Type	Method	Description
static @Nullable GitProvenance	fromProjectDirectory(Path projectDir)	Deprecated. Use instead.
static @Nullable GitProvenance	fromProjectDirectory(Path projectDir, @Nullable BuildEnvironment environment)
static @Nullable GitProvenance	fromProjectDirectory(Path projectDir, @Nullable BuildEnvironment environment, GitRemote.Parser gitRemoteParser)
@Nullable GitRemote	getGitRemote()
@Nullable String	getOrganizationName()
@Nullable String	getOrganizationName(String baseUrl)	Extract the organization name, including sub-organizations for git hosting services which support such a concept, from the origin URL.
@Nullable String	getRepositoryName()
@Nullable String	getRepositoryOrigin()
@Nullable String	getRepositoryPath()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openrewrite.marker.Marker

getId, print, withId

Constructor Details

GitProvenance

public GitProvenance(UUID id,
 @Nullable
 @Nullable String origin,
 @Nullable
 @Nullable String branch,
 @Nullable
 @Nullable String change,
 @Nullable
 @Nullable GitProvenance.AutoCRLF autocrlf,
 @Nullable
 @Nullable GitProvenance.EOL eol,
 @Nullable
 @Nullable List<GitProvenance.Committer> committers)

Method Details

getGitRemote

@Nullable
public @Nullable GitRemote getGitRemote()

getOrganizationName

@Nullable
public @Nullable String getOrganizationName(String baseUrl)

Extract the organization name, including sub-organizations for git hosting services which support such a concept, from the origin URL. Needs to be supplied with the

Parameters:

baseUrl - the portion of the URL which precedes the organization

Returns:

the portion of the git origin URL which corresponds to the organization the git repository is organized under

getOrganizationName

@Nullable
public @Nullable String getOrganizationName()

getRepositoryName

@Nullable
public @Nullable String getRepositoryName()

getRepositoryPath

@Nullable
public @Nullable String getRepositoryPath()

getRepositoryOrigin

@Nullable
public @Nullable String getRepositoryOrigin()

fromProjectDirectory

@Deprecated
@Nullable
public static @Nullable GitProvenance fromProjectDirectory(Path projectDir)

Deprecated.

Use instead.

Parameters:

projectDir - The project directory.

Returns:

A marker containing git provenance information.

fromProjectDirectory

@Nullable
public static @Nullable GitProvenance fromProjectDirectory(Path projectDir,
 @Nullable
 @Nullable BuildEnvironment environment)

Parameters:

projectDir - The project directory.

environment - In detached head scenarios, the branch is best determined from a BuildEnvironment marker if possible.

Returns:

A marker containing git provenance information.

fromProjectDirectory

@Nullable
public static @Nullable GitProvenance fromProjectDirectory(Path projectDir,
 @Nullable
 @Nullable BuildEnvironment environment,
 @Nullable
 GitRemote.Parser gitRemoteParser)

Parameters:

projectDir - The project directory.

environment - In detached head scenarios, the branch is best determined from a BuildEnvironment marker if possible.

gitRemoteParser - Parses the remote url into a GitRemote. Custom remotes can be registered to it, or a default with known git hosting services can be used.

Returns:

A marker containing git provenance information.