Package io.jenkins.blueocean.rest.model

Class BlueChangeSetEntry

java.lang.Object

io.jenkins.blueocean.rest.model.Resource

io.jenkins.blueocean.rest.model.BlueChangeSetEntry

All Implemented Interfaces:

Reachable

public abstract class BlueChangeSetEntry
extends Resource

Represents a single commit as a REST resource.

Author:

Ivan Meredith

Field Summary

Fields

Modifier and Type	Field	Description
static String	AFFECTED_PATHS
static String	AUTHOR
static String	CHECKOUT_COUNT
static String	COMMIT_ID
static String	ISSUES
static String	MESSAGE
static String	TIMESTAMP
static String	URL

Constructor Summary

Constructors

Constructor	Description
BlueChangeSetEntry()

Method Summary

Modifier and Type	Method	Description
abstract Collection<String>	getAffectedPaths()	Returns a set of paths in the workspace that was affected by this change.
abstract BlueUser	getAuthor()	The user who made this change.
abstract Integer	getCheckoutCount()
abstract String	getCommitId()	Returns a human readable display name of the commit number, revision number, and such thing that identifies this entry.
abstract Collection<BlueIssue>	getIssues()
abstract String	getMsg()	Gets the "commit message".
abstract String	getTimestamp()	Returns the timestamp of this commit.
abstract String	getUrl()	Returns a browser friendly url to the commit.
abstract BlueChangeSetEntry	setCheckoutCount(int checkoutCount)

Methods inherited from class io.jenkins.blueocean.rest.model.Resource

getLinks, getState

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jenkins.blueocean.rest.Reachable

getLink

Field Detail

AUTHOR

public static final String AUTHOR

See Also:

Constant Field Values

COMMIT_ID

public static final String COMMIT_ID

See Also:

Constant Field Values

TIMESTAMP

public static final String TIMESTAMP

See Also:

Constant Field Values

MESSAGE

public static final String MESSAGE

See Also:

Constant Field Values

AFFECTED_PATHS

public static final String AFFECTED_PATHS

See Also:

Constant Field Values

URL

public static final String URL

See Also:

Constant Field Values

ISSUES

public static final String ISSUES

See Also:

Constant Field Values

CHECKOUT_COUNT

public static final String CHECKOUT_COUNT

See Also:

Constant Field Values

Constructor Detail

BlueChangeSetEntry

public BlueChangeSetEntry()

Method Detail

getCommitId

@Nullable
@Exported(name="commitId")
public abstract String getCommitId()

Returns a human readable display name of the commit number, revision number, and such thing that identifies this entry.

Returns:

null if such a concept doesn't make sense for the implementation. For example, in CVS there's no single identifier for commits. Each file gets a different revision number.

getAuthor

@NonNull
@Exported(name="author",
          inline=true)
public abstract BlueUser getAuthor()

The user who made this change.

Returns:

never null.

getTimestamp

@Nullable
@Exported(name="timestamp")
public abstract String getTimestamp()

Returns the timestamp of this commit.

Returns:

null if the implementation doesn't support it (for example, in CVS a commit spreads over time between multiple changes on multiple files, so there's no single timestamp.)

getMsg

@NonNull
@Exported(name="msg")
public abstract String getMsg()

Gets the "commit message".

Returns:

Can be empty but never null.

getAffectedPaths

@NonNull
@Exported(name="affectedPaths")
public abstract Collection<String> getAffectedPaths()

Returns a set of paths in the workspace that was affected by this change.

Contains string like 'foo/bar/zot'. No leading/trailing '/', and separator must be normalized to '/'.

Returns:

never null.

getUrl

@Nullable
@Exported(name="url")
public abstract String getUrl()

Returns a browser friendly url to the commit. E.g to github, or bitbucket.

Returns:

null if no applicable website exists

getIssues

@Exported(name="issues",
          skipNull=true,
          inline=true)
public abstract Collection<BlueIssue> getIssues()

Returns:

issue

getCheckoutCount

@Exported(name="checkoutCount")
public abstract Integer getCheckoutCount()

setCheckoutCount

public abstract BlueChangeSetEntry setCheckoutCount(int checkoutCount)