org.microbean.helm.maven

Class GetHistoryMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.microbean.helm.maven.AbstractHelmMojo

org.microbean.helm.maven.AbstractReleaseMojo

org.microbean.helm.maven.AbstractSingleReleaseMojo

org.microbean.helm.maven.GetHistoryMojo

All Implemented Interfaces:

ContextEnabled, Mojo

@Mojo(name="history")
public class GetHistoryMojo
extends AbstractSingleReleaseMojo

Retrieves the history of a release.

Author:

Laird Nelson

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
GetHistoryMojo() Creates a new GetHistoryMojo.

Method Summary

Modifier and Type	Method and Description
void	addReleaseHistoryListener(ReleaseHistoryListener listener) Adds a ReleaseHistoryListener that will be notified when a release history is retrieved
protected void	execute(Callable<ReleaseManager> releaseManagerCallable) Performs a release-oriented task using a ReleaseManager available from the supplied Callable.
int	getMax() Returns the maximum number of history entries to retrieve.
ReleaseHistoryListener[]	getReleaseHistoryListeners() Invokes the getReleaseHistoryListenersList() method and converts its return value to an array.
List<ReleaseHistoryListener>	getReleaseHistoryListenersList() Returns the List of ReleaseHistoryListeners whose elements will be notified when a release history is retrieved.
void	removeReleaseHistoryListener(ReleaseHistoryListener listener) Removes a ReleaseHistoryListener from this GetHistoryMojo.
void	setMax(int max) Sets the maximum number of history entries to retrieve.
void	setReleaseHistoryListenersList(List<ReleaseHistoryListener> releaseHistoryListeners) Installs the List of ReleaseHistoryListeners whose elements will be notified when a release history is retrieved.

Methods inherited from class org.microbean.helm.maven.AbstractSingleReleaseMojo

getReleaseName, setReleaseName, validateReleaseName

Methods inherited from class org.microbean.helm.maven.AbstractReleaseMojo

createClient, createReleaseManager, createTiller, execute, getClientConfiguration, getSkip, getTillerLabels, getTillerNamespace, getTillerPort, setClientConfiguration, setSkip, setTillerLabels, setTillerNamespace, setTillerPort, validateNamespace

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

GetHistoryMojo

public GetHistoryMojo()

Creates a new GetHistoryMojo.

Method Detail

execute

protected void execute(Callable<ReleaseManager> releaseManagerCallable)
                throws Exception

Performs a release-oriented task using a ReleaseManager available from the supplied Callable.

This implementation retrieves the history for a given release and notifies registered ReleaseHistoryListeners.

Specified by:

execute in class AbstractReleaseMojo

Parameters:

releaseManagerCallable - the Callable that will provide a ReleaseManager; must not be null

Throws:

Exception - if an error occurs

getMax

public int getMax()

Returns the maximum number of history entries to retrieve.

Returns:

the maximum number of history entries to retrieve

See Also:

setMax(int)

setMax

public void setMax(int max)

Sets the maximum number of history entries to retrieve.

Parameters:

max - the maximum number of history entries to retrieve

See Also:

getMax()

addReleaseHistoryListener

public void addReleaseHistoryListener(ReleaseHistoryListener listener)

Adds a ReleaseHistoryListener that will be notified when a release history is retrieved

Parameters:

listener - the ReleaseHistoryListener to add; may be null in which case no action will be taken

See Also:

removeReleaseHistoryListener(ReleaseHistoryListener), getReleaseHistoryListenersList()

removeReleaseHistoryListener

public void removeReleaseHistoryListener(ReleaseHistoryListener listener)

Removes a ReleaseHistoryListener from this GetHistoryMojo.

Parameters:

listener - the ReleaseHistoryListener to remove; may be null in which case no action will be taken

See Also:

addReleaseHistoryListener(ReleaseHistoryListener), getReleaseHistoryListenersList()

getReleaseHistoryListeners

public ReleaseHistoryListener[] getReleaseHistoryListeners()

Invokes the getReleaseHistoryListenersList() method and converts its return value to an array.

This method never returns null.

Overrides of this method must not return null.

Returns:

a non-null array of ReleaseHistoryListeners

See Also:

getReleaseHistoryListenersList()

getReleaseHistoryListenersList

public List<ReleaseHistoryListener> getReleaseHistoryListenersList()

Returns the List of ReleaseHistoryListeners whose elements will be notified when a release history is retrieved.

This method may return null.

Overrides of this method are permitted to return null.

Returns:

a List of ReleaseHistoryListeners, or null

See Also:

setReleaseHistoryListenersList(List), addReleaseHistoryListener(ReleaseHistoryListener), removeReleaseHistoryListener(ReleaseHistoryListener)

setReleaseHistoryListenersList

public void setReleaseHistoryListenersList(List<ReleaseHistoryListener> releaseHistoryListeners)

Installs the List of ReleaseHistoryListeners whose elements will be notified when a release history is retrieved.

Parameters:

releaseHistoryListeners - the List of ReleaseHistoryListeners whose elements will be notified when a release history is retrieved; may be null

See Also:

getReleaseHistoryListenersList(), addReleaseHistoryListener(ReleaseHistoryListener), removeReleaseHistoryListener(ReleaseHistoryListener)