Package bm.machine

Class Machine

java.lang.Object

bm.machine.Machine

public class Machine
extends Object

Machinery to build things. Use update(bm.machine.Target) to update a target.

Constructor Summary

Constructors

Constructor	Description
Machine(SupplyOrThrow<StateStore> stateStoreSupplier)	Creates the machine with its state store.

Method Summary

Modifier and Type	Method	Description
List<Target>	triggeringDepencendies(Target target)	Once the target's update process has proceeded far enough to be sure about the dependencies that are triggering its recreation, this returns those dependencies, otherwise null is returned.
void	update(Target target)	Updates the target, i.e.
boolean	wasRecreated(Target target)	Was the target actually recreated so far?
boolean	wasUpdated(Target target)	Was a target updated so far?

Methods inherited from class java.lang.Object

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

Constructor Details

Machine

public Machine(SupplyOrThrow<StateStore> stateStoreSupplier)

Creates the machine with its state store. The state store is used to store hashes of targets which allow to find out whether a target has changed since last looked at.

Parameters:

stateStoreSupplier - to be called at the start of update(bm.machine.Target) to obtain the state store where to persist target states between invocations.

See Also:

• PropertiesStateStore
• FilesStateStore

Method Details

wasUpdated

public boolean wasUpdated(Target target)
                   throws BuildProblemException

Was a target updated so far?

Parameters:

target - to query

Returns:

true if update(bm.machine.Target) was run for the target.

Throws:

BuildProblemException

wasRecreated

public boolean wasRecreated(Target target)
                     throws BuildProblemException

Was the target actually recreated so far?

Parameters:

target - to query

Returns:

true if Target.recreate() was run for the target.

Throws:

BuildProblemException

triggeringDepencendies

public List<Target> triggeringDepencendies(Target target)
                                    throws BuildProblemException

Once the target's update process has proceeded far enough to be sure about the dependencies that are triggering its recreation, this returns those dependencies, otherwise null is returned.

Parameters:

target - to query

Returns:

the triggering dependencies, which may be empty

Throws:

BuildProblemException

update

public void update(Target target)
            throws BuildProblemException

Updates the target, i.e. it makes sure Target.recreate() is called if this is necessary. In particular all dependencies are updated first, if they were not updated already. If a hash created by combining StateProvider.addState(java.util.function.Consumer<byte[]>) of all dependencies with the one of the given target is different from the previously stored hash, if any, Target.recreate() is called.

Throws:

BuildProblemException - as needed