Package io.jenkins.plugins.forensics.util

Class CommitDecorator

java.lang.Object

io.jenkins.plugins.forensics.util.CommitDecorator

Direct Known Subclasses:

CommitDecorator.NullDecorator

public abstract class CommitDecorator
extends Object

A RepositoryBrowser for commits. Since a RepositoryBrowser has no API to generate links to simple commits, this decorator adds such a functionality. Note that this API does not only obtain such links, it also renders these links as HTML a tags.

Author:

Ullrich Hafner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommitDecorator.NullDecorator	A decorator that does nothing.

Constructor Summary

Constructors

Constructor	Description
CommitDecorator()

Method Summary

Modifier and Type	Method	Description
abstract String	asLink(String id)	Obtains a link for the specified commit ID.
String	asText(String id)	Renders the commit ID as a human-readable text.
String	getRawLink(String id)	Returns the raw link for the specified commit ID.

Methods inherited from class java.lang.Object

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

Constructor Details

CommitDecorator

public CommitDecorator()

Method Details

asLink

public abstract String asLink(String id)

Obtains a link for the specified commit ID.

Parameters:

id - the ID of the commit

Returns:

an HTML a tag that contains a link to the commit

getRawLink

public String getRawLink(String id)

Returns the raw link for the specified commit ID.

Parameters:

id - the ID of the commit

Returns:

a raw link to the commit, e.g. https://github.com/jenkinsci/analysis-model/commit/9f5eb8b28e422d6249e6c29dc65173a59f2d9f6f

asText

public String asText(String id)

Renders the commit ID as a human-readable text.

Parameters:

id - the ID of the commit

Returns:

a commit ID as human-readable text