com.atlassian.plugins.codegen

Class PluginProjectChangeset

java.lang.Object

com.atlassian.plugins.codegen.PluginProjectChangeset

public final class PluginProjectChangeset
extends Object

Describes changes that should be applied to the project. These may include changes to the POM, the plugin XML file, and any other files within the project. Implementations of PluginModuleCreator return an instance of this class rather than performing the changes directly.

This class is immutable; all of its non-getter methods return new instances.

This class also contains static factory methods for all supported change types.

Constructor Summary

Constructors

Constructor and Description
PluginProjectChangeset()

Method Summary

Methods

Modifier and Type	Method and Description
static PluginProjectChangeset	changeset()
Iterable<String>	getAllChangeDescriptions() Returns the toString() description of every change in the changeset.
Iterable<String>	getChangeDescriptionsOrSummaries() Returns the toString() description of every change in the changeset, sorted by type, except for changes that implement SummarizeAsGroup, which will instead be counted.
Iterable<PluginProjectChange>	getItems() Returns all changes in the changeset.
<T extends PluginProjectChange> Iterable<T>	getItems(Class<T> itemClass) Returns only the changes of the specified class.
boolean	hasItems(Class<? extends PluginProjectChange> itemClass) Returns true if the changeset contains any items of the specified class.
String	toString()
PluginProjectChangeset	with(Iterable<? extends PluginProjectChange> newChanges) Returns a copy of this changeset with the specified item(s) added.
PluginProjectChangeset	with(PluginProjectChange... newChanges) Returns a copy of this changeset with the specified item(s) added.
PluginProjectChangeset	with(PluginProjectChangeset other) Returns a changeset consisting of this changeset plus all items from another changeset.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginProjectChangeset

public PluginProjectChangeset()

Method Detail

changeset

public static PluginProjectChangeset changeset()

getItems

public Iterable<PluginProjectChange> getItems()

Returns all changes in the changeset.

getItems

public <T extends PluginProjectChange> Iterable<T> getItems(Class<T> itemClass)

Returns only the changes of the specified class.

hasItems

public boolean hasItems(Class<? extends PluginProjectChange> itemClass)

Returns true if the changeset contains any items of the specified class.

with

public PluginProjectChangeset with(PluginProjectChange... newChanges)

Returns a copy of this changeset with the specified item(s) added.

with

public PluginProjectChangeset with(Iterable<? extends PluginProjectChange> newChanges)

Returns a copy of this changeset with the specified item(s) added.

with

public PluginProjectChangeset with(PluginProjectChangeset other)

Returns a changeset consisting of this changeset plus all items from another changeset.

getAllChangeDescriptions

public Iterable<String> getAllChangeDescriptions()

Returns the toString() description of every change in the changeset.

getChangeDescriptionsOrSummaries

public Iterable<String> getChangeDescriptionsOrSummaries()

Returns the toString() description of every change in the changeset, sorted by type, except for changes that implement SummarizeAsGroup, which will instead be counted.

toString

public String toString()

Overrides:

toString in class Object