Package com.mooltiverse.oss.nyx.command

Class Arrange

java.lang.Object

com.mooltiverse.oss.nyx.command.AbstractCommand

com.mooltiverse.oss.nyx.command.Arrange

All Implemented Interfaces:

Command

public class Arrange
extends AbstractCommand

The Arrange command takes care of fixing the local Git repository, if needed. This class is not meant to be used in multi-threaded environments.

Constructor Summary

Constructors

Constructor	Description
Arrange(State state, Repository repository)	Standard constructor.

Method Summary

Modifier and Type	Method	Description
boolean	isUpToDate()	Returns true if this command is up to date, which means that the internal state (Command.state()) would not change by running (Command.run()) the command again.
State	run()	Runs the command and returns the updated reference to the state object.

Methods inherited from class com.mooltiverse.oss.nyx.command.AbstractCommand

getLatestCommit, isInternalAttributeUpToDate, isRepositoryClean, repository, state, storeInternalAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

Arrange

public Arrange(State state,
               Repository repository)

Standard constructor.

Parameters:

state - the state reference

repository - the repository reference

Throws:

NullPointerException - if a given argument is null

Method Detail

isUpToDate

public boolean isUpToDate()
                   throws DataAccessException,
                          IllegalPropertyException,
                          GitException

Returns true if this command is up to date, which means that the internal state (Command.state()) would not change by running (Command.run()) the command again. It other words, when this method returns true any invocation of the (Command.run()) method is needless and idempotent about the state. This method uses the quickest method to verify whether the state is up to date or not. This method must not rely on dependencies and it must always evaluate its own status independently. As a general rule this method checks if its inputs (i.e. from the configuration) have changed since the last run.

Returns:

true if this command is up to date

Throws:

DataAccessException - in case the configuration can't be loaded for some reason.

IllegalPropertyException - in case the configuration has some illegal options.

GitException - in case of unexpected issues when accessing the Git repository.

See Also:

Command.state(), Command.run()

run

public State run()
          throws DataAccessException,
                 IllegalPropertyException,
                 GitException,
                 ReleaseException

Runs the command and returns the updated reference to the state object. In order to improve performances you should only invoke this method when Command.isUpToDate() returns false.

Returns:

the updated reference to the state object. The returned object is the same instance passed in the constructor or null if the command has cleared the state.

Throws:

DataAccessException - in case the configuration can't be loaded for some reason.

IllegalPropertyException - in case the configuration has some illegal options.

GitException - in case of unexpected issues when accessing the Git repository.

ReleaseException - if the task is unable to complete for reasons due to the release process.

See Also:

Command.isUpToDate(), Command.state()