RichTextFX 0.11.5 · org.fxmisc.richtext.model.TextChange

Modifier and Type	Field and Description
protected final S	inserted
protected final int	position
protected final S	removed

Access	Constructor and Description
public	TextChange(int position, S removed, S inserted)

Method Summary

Modifier and Type	Method and Description
protected abstract S	concat(S a, S b)
protected abstract Self	create(int position, S removed, S inserted)
public boolean	equals(Object other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public S	getInserted()
public int	getInsertionEnd() Returns the position where the inserted ends (e.g. `position + insertedLength())`
public int	getNetLength() Gets the net length of this change (i.e., `insertedLength() - removedLength()`)
public int	getPosition() Gets the start position of where the replacement happened
public int	getRemovalEnd() Returns the position where the removal ends (e.g. `position + removedLength())`
public S	getRemoved()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
protected abstract int	insertedLength()
public Self	invert() Returns a new subclass of `TextChange` that makes the `inserted` the removed object and the `removed` the inserted object
public final boolean	isIdentity() Returns true if this change is an identity change: applying it does nothing as it removes what it inserts.
public Optional<Self>	Returns: a new merged change if changes can be merged, `null` otherwise. mergeWith(Self change to merge with this change. latter) Merges this change with the given change, if possible.
protected abstract int	removedLength()
protected abstract S	sub(S s, int from, int to)
public final String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

inserted	back to summary
protected final S inserted

position	back to summary
protected final int position

removed	back to summary
protected final S removed

TextChange	back to summary
public TextChange(int position, S removed, S inserted)

Method Detail

concat	back to summary
protected abstract S concat(S a, S b)

create	back to summary
protected abstract Self create(int position, S removed, S inserted)

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getInserted	back to summary
public S getInserted()

getInsertionEnd	back to summary
public int getInsertionEnd() Returns the position where the inserted ends (e.g. `position + insertedLength())`

getNetLength	back to summary
public int getNetLength() Gets the net length of this change (i.e., `insertedLength() - removedLength()`)

getPosition	back to summary
public int getPosition() Gets the start position of where the replacement happened

getRemovalEnd	back to summary
public int getRemovalEnd() Returns the position where the removal ends (e.g. `position + removedLength())`

getRemoved	back to summary
public S getRemoved()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

insertedLength	back to summary
protected abstract int insertedLength()

invert	back to summary
public Self invert() Returns a new subclass of `TextChange` that makes the `inserted` the removed object and the `removed` the inserted object

isIdentity	back to summary
public final boolean isIdentity() Returns true if this change is an identity change: applying it does nothing as it removes what it inserts. See also `java.util.function.Function#identity()`

mergeWith back to summary

mergeWith	back to summary
public Optional<Self> mergeWith(Self latter) Merges this change with the given change, if possible. This change is considered to be the former and the given change is considered to be the latter. Changes can be merged if either the latter's start matches the former's added text end; or the latter's removed text end matches the former's added text end. Parameters latter:Self change to merge with this change. Returns:Optional<Self> a new merged change if changes can be merged, `null` otherwise.

public Optional<Self> mergeWith(Self latter)

Merges this change with the given change, if possible. This change is considered to be the former and the given change is considered to be the latter. Changes can be merged if either

the latter's start matches the former's added text end; or
the latter's removed text end matches the former's added text end.

Parameters

latter:Self: change to merge with this change.

Returns:Optional<Self>

a new merged change if changes can be merged, null otherwise.

removedLength	back to summary
protected abstract int removedLength()

sub	back to summary
protected abstract S sub(S s, int from, int to)

toString back to summary

toString	back to summary
public final String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public abstract Class TextChange<S, Self extends TextChange<S, Self>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail