Package com.polarion.alm.shared.api.model.fields

Interface FieldDifferences

public interface FieldDifferences

Result of comparing 2 fields using the Field.compareWith(Field) method.

Since:

3.10.0

Method Summary

Modifier and Type	Method	Description
boolean	isEmpty()
Field	leftField()
Renderer<? extends Renderer>	renderLeft()	Renders the differences in the left field.
Renderer<? extends Renderer>	renderRight()	Renders the differences in the right field.
Field	rightField()

Method Details

isEmpty

boolean isEmpty()

Returns:

true when there are no differences.

leftField

@NotNull
Field leftField()

Returns:

the reference to the original field on which the method Field.compareWith(Field) was called.

rightField

@NotNull
Field rightField()

Returns:

the reference to the field which passed as parameter to the method Field.compareWith(Field).

renderLeft

@NotNull
Renderer<? extends Renderer> renderLeft()

Renders the differences in the left field. Behavior of this method is undefined when the isEmpty() method returns true, so the callers must always check that the isEmpty() method returns false before calling this method.

renderRight

@NotNull
Renderer<? extends Renderer> renderRight()

Renders the differences in the right field. Behavior of this method is undefined when the isEmpty() method returns true, so the callers must always check that the isEmpty() method returns false before calling this method.