org.corfudb.annotations

Annotation Type MutatorAccessor

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Inherited
public @interface MutatorAccessor

Marks a mutatorAccessor, which is an method that modifies the state of an object, then reads back the result of that modification. Created by mwei on 1/7/16.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	conflictParameterFunction The name of the function used to generate conflict parameters, which will be used to generate conflict information.
String	name The name of the mutator, which will be written to the log.
boolean	noUpcall Whether or not we should generate an upcall for this mutator.
boolean	reset Whether this mutator resets the state of this object.
String	undoFunction The name of the function to undo this mutation, which needs to belong to the same object.
String	undoRecordFunction The name of the function which will be called prior to applying this mutator, which will be used to generate an undo record.

Element Detail

name

public abstract String name

The name of the mutator, which will be written to the log.

Returns:

The name of the mutator.

Default:

""

undoFunction

public abstract String undoFunction

The name of the function to undo this mutation, which needs to belong to the same object.

Returns:

The name of the undo function.

Default:

""

undoRecordFunction

public abstract String undoRecordFunction

The name of the function which will be called prior to applying this mutator, which will be used to generate an undo record.

Returns:

The name of the undoRecord function.

Default:

""

conflictParameterFunction

public abstract String conflictParameterFunction

The name of the function used to generate conflict parameters, which will be used to generate conflict information.

Returns:

The name of a conflict generation function.

Default:

""

reset

public abstract boolean reset

Whether this mutator resets the state of this object. Typically used for methods like clear().

Returns:

True, if the mutator resets the object.

Default:

false

noUpcall

public abstract boolean noUpcall

Whether or not we should generate an upcall for this mutator. If set to true, no upcall will be generated - this is typically used when providing a mutator-only version of a mutatorAccessor (for example, "blindPut" and "put").

Returns:

True, if no upcall should be generated.

Default:

false