Package com.google.gerrit.server.patch

Class GitPositionTransformer.PositionedEntity<T>

java.lang.Object

com.google.gerrit.server.patch.GitPositionTransformer.PositionedEntity<T>

Type Parameters:

T - an object/entity type which has a GitPositionTransformer.Position

Enclosing class:

GitPositionTransformer

public static class GitPositionTransformer.PositionedEntity<T>
extends Object

Wrapper around an instance of T which annotates it with a GitPositionTransformer.Position. Methods such as shiftPositionBy(int) and withFilePath(String) allow to update the associated GitPositionTransformer.Position. Afterwards, use getEntityAtUpdatedPosition() to get an updated version of the T instance.

Method Summary

Modifier and Type	Method	Description
static <T> GitPositionTransformer.PositionedEntity<T>	create(T entity, Function<T,GitPositionTransformer.Position> positionExtractor, BiFunction<T,GitPositionTransformer.Position,T> updatedEntityCreator)	Creates a new PositionedEntity.
T	getEntity()	Returns the original underlying entity.
T	getEntityAtUpdatedPosition()	Returns an updated version of the entity to which the internally stored GitPositionTransformer.Position was written back to.
GitPositionTransformer.PositionedEntity<T>	shiftPositionBy(int amount)	Shifts the tracked GitPositionTransformer.Position by the specified amount.
GitPositionTransformer.PositionedEntity<T>	withFilePath(String filePath)	Updates the file path of the tracked GitPositionTransformer.Position.
GitPositionTransformer.PositionedEntity<T>	withPosition(GitPositionTransformer.Position newPosition)	Updates the tracked GitPositionTransformer.Position.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <T> GitPositionTransformer.PositionedEntity<T> create(T entity,
                                                                    Function<T,GitPositionTransformer.Position> positionExtractor,
                                                                    BiFunction<T,GitPositionTransformer.Position,T> updatedEntityCreator)

Creates a new PositionedEntity.

Type Parameters:

T - an object/entity type which has a GitPositionTransformer.Position

Parameters:

entity - an instance which should be annotated with a GitPositionTransformer.Position

positionExtractor - a function describing how a GitPositionTransformer.Position can be derived from the given entity

updatedEntityCreator - a function to create a new entity of type T from an existing entity and a given GitPositionTransformer.Position. This must return a new instance of type T! The existing instance must not be modified!

getEntity

public T getEntity()

Returns the original underlying entity.

Returns:

the original instance of T

getEntityAtUpdatedPosition

public T getEntityAtUpdatedPosition()

Returns an updated version of the entity to which the internally stored GitPositionTransformer.Position was written back to.

Returns:

an updated instance of T

shiftPositionBy

public GitPositionTransformer.PositionedEntity<T> shiftPositionBy(int amount)

Shifts the tracked GitPositionTransformer.Position by the specified amount.

Parameters:

amount - number of lines to shift. Negative values mean moving the range up, positive values mean moving the range down.

Returns:

a PositionedEntity with updated GitPositionTransformer.Position

withFilePath

public GitPositionTransformer.PositionedEntity<T> withFilePath(String filePath)

Updates the file path of the tracked GitPositionTransformer.Position.

Parameters:

filePath - the new file path to use

Returns:

a PositionedEntity with updated GitPositionTransformer.Position

withPosition

public GitPositionTransformer.PositionedEntity<T> withPosition(GitPositionTransformer.Position newPosition)

Updates the tracked GitPositionTransformer.Position.

Returns:

a PositionedEntity with updated GitPositionTransformer.Position