Package dev.getelements.elements.rt.transact.unix

Class UnixFSTransactionProgramBuilder

java.lang.Object

dev.getelements.elements.rt.transact.unix.UnixFSTransactionProgramBuilder

public class UnixFSTransactionProgramBuilder
extends Object

Used to compile a set of instructions into a UnixFSTransactionProgram used for committing the requested transactions to disk. This does no checking of the underlying database, and assumes that the calling code has properly completed all pre-checks while building the code.

Constructor Summary

Constructors

Constructor	Description
UnixFSTransactionProgramBuilder()

Method Summary

Modifier and Type	Method	Description
UnixFSTransactionProgramBuilder	applyChangeToResourceContents(UnixFSTransactionProgramExecutionPhase executionPhase, ResourceId resourceId)	Applies the contents change ot the resource.
UnixFSTransactionProgramBuilder	applyChangeToTasks(UnixFSTransactionProgramExecutionPhase executionPhase, ResourceId resourceId)	Applies the supplied ResourceId changes to the data store for the associated tasks.
UnixFSTransactionProgramBuilder	applyReversePathChangeToResource(UnixFSTransactionProgramExecutionPhase executionPhase, ResourceId resourceId)	Applies the supplied ResourceId changes to the data store.
UnixFSTransactionProgramBuilder	applyReversePathChangeToResource(UnixFSTransactionProgramExecutionPhase executionPhase, Path path)	Applies the changes for the supplied Path to the data store.
UnixFSTransactionProgramBuilder	cleanupResource(UnixFSTransactionProgramExecutionPhase executionPhase, ResourceId resourceId)	Cleans up the supplied ResourceId changes from the data store.
UnixFSTransactionProgramBuilder	cleanupResource(UnixFSTransactionProgramExecutionPhase executionPhase, Path path)	Cleans up the supplied Path changes from the data store.
UnixFSTransactionProgramBuilder	cleanupTasksForResource(UnixFSTransactionProgramExecutionPhase executionPhase, ResourceId resourceId)	Cleans up the tasks for the supplied ResourceId.
UnixFSTransactionProgram	compile(UnixFSTransactionProgramExecutionPhase... executionPhases)	Compiles this program, setting the header values as well as writing the bytecode to ByteBuffer containing the program's instructions.
ByteBuffer	getByteBuffer()	Gets the ByteBuffer to store the program contents.
UnixFSChecksumAlgorithm	getChecksumAlgorithm()	Gets the UnixFSChecksumAlgorithm used to commit the program.
NodeId	getNodeId()	Gets the revision to write.
String	getTransactionId()	Gets the transaction ID.
UnixFSTransactionProgramBuilder	withByteBuffer(ByteBuffer byteBuffer)	Specifies the ByteBuffer which will hold the program's code.
UnixFSTransactionProgramBuilder	withChecksumAlgorithm(UnixFSChecksumAlgorithm checksumAlgorithm)	Specifies the UnixFSChecksumAlgorithm to use to guarantee the program's integrity.
UnixFSTransactionProgramBuilder	withNodeId(NodeId nodeId)	Specifies the NodeId to associate with the program.
UnixFSTransactionProgramBuilder	withTransactionId(String transactionId)	Gets the id for the currently running transaction.

Methods inherited from class java.lang.Object

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

Constructor Details

UnixFSTransactionProgramBuilder

public UnixFSTransactionProgramBuilder()

Method Details

withNodeId

public UnixFSTransactionProgramBuilder withNodeId(NodeId nodeId)

Specifies the NodeId to associate with the program. The NodeId is used to

Parameters:

nodeId - the NodeId

Returns:

this instance

withTransactionId

public UnixFSTransactionProgramBuilder withTransactionId(String transactionId)

Gets the id for the currently running transaction.

Parameters:

transactionId - the transaction id.

Returns:

this instance

withByteBuffer

public UnixFSTransactionProgramBuilder withByteBuffer(ByteBuffer byteBuffer)

Specifies the ByteBuffer which will hold the program's code.

Parameters:

byteBuffer - the ByteBuffer to hold the program's code.

Returns:

this instance

withChecksumAlgorithm

public UnixFSTransactionProgramBuilder withChecksumAlgorithm(UnixFSChecksumAlgorithm checksumAlgorithm)

Specifies the UnixFSChecksumAlgorithm to use to guarantee the program's integrity.

Parameters:

checksumAlgorithm - the UnixFSChecksumAlgorithm to use

Returns:

this instance

applyReversePathChangeToResource

public UnixFSTransactionProgramBuilder applyReversePathChangeToResource(UnixFSTransactionProgramExecutionPhase executionPhase,
 Path path)

Applies the changes for the supplied Path to the data store.

Parameters:

executionPhase - the execution phase to use

path - the Path to apply

Returns:

this instance

applyChangeToResourceContents

public UnixFSTransactionProgramBuilder applyChangeToResourceContents(UnixFSTransactionProgramExecutionPhase executionPhase,
 ResourceId resourceId)

Applies the contents change ot the resource.

Parameters:

executionPhase - the execution phase to use

resourceId - the ResourceId to apply

Returns:

this instance

applyReversePathChangeToResource

public UnixFSTransactionProgramBuilder applyReversePathChangeToResource(UnixFSTransactionProgramExecutionPhase executionPhase,
 ResourceId resourceId)

Applies the supplied ResourceId changes to the data store.

Parameters:

executionPhase - the execution phase to use

resourceId - the ResourceId to apply

Returns:

this instance

applyChangeToTasks

public UnixFSTransactionProgramBuilder applyChangeToTasks(UnixFSTransactionProgramExecutionPhase executionPhase,
 ResourceId resourceId)

Applies the supplied ResourceId changes to the data store for the associated tasks.

Parameters:

executionPhase - the execution phase to use

resourceId - the Path to apply

Returns:

this instance

cleanupResource

public UnixFSTransactionProgramBuilder cleanupResource(UnixFSTransactionProgramExecutionPhase executionPhase,
 Path path)

Cleans up the supplied Path changes from the data store.

Parameters:

executionPhase - the execution phase to use

path - the Path to apply

Returns:

this instance

cleanupResource

public UnixFSTransactionProgramBuilder cleanupResource(UnixFSTransactionProgramExecutionPhase executionPhase,
 ResourceId resourceId)

Cleans up the supplied ResourceId changes from the data store.

Parameters:

executionPhase - the execution phase to use

resourceId - the Path to apply

Returns:

this instance

cleanupTasksForResource

public UnixFSTransactionProgramBuilder cleanupTasksForResource(UnixFSTransactionProgramExecutionPhase executionPhase,
 ResourceId resourceId)

Cleans up the tasks for the supplied ResourceId.

Parameters:

executionPhase - the execution phase

resourceId - the ResourceId

Returns:

this instance

compile

public UnixFSTransactionProgram compile(UnixFSTransactionProgramExecutionPhase... executionPhases)

Compiles this program, setting the header values as well as writing the bytecode to ByteBuffer containing the program's instructions. This does clear the checksum header, however, it does does not calculate the final checksum as that is part of the committing process.

Returns:

a freshly compiled instance of UnixFSTransactionProgram

getNodeId

public NodeId getNodeId()

Gets the revision to write.

Returns:

the node id

getByteBuffer

public ByteBuffer getByteBuffer()

Gets the ByteBuffer to store the program contents.

Returns:

the ByteBuffer

getTransactionId

public String getTransactionId()

Gets the transaction ID.

Returns:

the transaction id

getChecksumAlgorithm

public UnixFSChecksumAlgorithm getChecksumAlgorithm()

Gets the UnixFSChecksumAlgorithm used to commit the program.

Returns:

the UnixFSChecksumAlgorithm