org.apache.jackrabbit.mongomk.api.model

Interface Commit

All Known Implementing Classes:

MongoCommit

public interface Commit

A higher level object representing a commit.

Method Summary

Methods

Modifier and Type	Method and Description
SortedSet<String>	getAffectedPaths() Returns the paths affected by the commit.
Long	getBaseRevisionId() Returns the base revision id the commit is based on.
String	getBranchId() Returns the private branch id the commit is under or null if the commit is in the public branch.
String	getDiff() Returns the JSOP diff of this commit.
List<Instruction>	getInstructions() Returns the List of Instructions which were created from the diff.
String	getMessage() Returns the message of the commit.
String	getPath() Returns the path of the root node of this commit.
Long	getRevisionId() Returns the revision id of this commit if known already, else this will return null.
Long	getTimestamp() Returns the timestamp of this commit.
boolean	isFailed() Determines whether the commit failed or not.
void	setRevisionId(Long revisionId) Sets the revision id of this commit.

Method Detail

getAffectedPaths

SortedSet<String> getAffectedPaths()

Returns the paths affected by the commit.

Returns:

The paths affected by the commit.

getBaseRevisionId

Long getBaseRevisionId()

Returns the base revision id the commit is based on.

Returns:

The base revision id the commit is based on.

getBranchId

String getBranchId()

Returns the private branch id the commit is under or null if the commit is in the public branch.

Returns:

The private branch id or null

getDiff

String getDiff()

Returns the JSOP diff of this commit.

Returns:

The String representing the diff.

isFailed

boolean isFailed()

Determines whether the commit failed or not.

Returns:

True if the commit failed.

getInstructions

List<Instruction> getInstructions()

Returns the List of Instructions which were created from the diff.

Returns:

The List of Instructions.

See Also:

getDiff()

getMessage

String getMessage()

Returns the message of the commit.

Returns:

The message.

getPath

String getPath()

Returns the path of the root node of this commit.

Returns:

The path of the root node.

getRevisionId

Long getRevisionId()

Returns the revision id of this commit if known already, else this will return null. The revision id will be determined only after the commit has been successfully performed.

Returns:

The revision id of this commit or null.

setRevisionId

void setRevisionId(Long revisionId)

Sets the revision id of this commit.

Parameters:

revisionId - The revision id to set.

getTimestamp

Long getTimestamp()

Returns the timestamp of this commit.

Returns:

The timestamp of this commit.