Top Description Inners Fields Constructors Methods
com.vladsch.flexmark.util.format

public final Class TrackedOffset

extends Object
implements Comparable<TrackedOffset>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Imports
com.vladsch.flexmark.util.misc.BitFieldSet, org.jetbrains.annotations.NotNull, .Nullable

Tracked Offset information

Note

purposefully equals compares the offset only and will equal an integer of the same value to allow use of TrackedOffset as a key but lookup to be done by offset

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static enum

Field Summary

Modifier and TypeField and Description
private static final int
private static final int
private static final int
private final int
private int
private boolean
private final int
private final @Nullable TrackedOffset
private int
private int

Constructor Summary

AccessConstructor and Description
private
TrackedOffset(int offset, boolean afterSpaceEdit, boolean afterInsert, boolean afterDelete)

private
private

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(@NotNull TrackedOffset
the object to be compared.
o
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public int
compareTo(@NotNull Integer
the object to be compared.
o
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public int
compareTo(int
the object to be compared.
offset
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

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

public int
public int
public int
public int
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
public boolean
public boolean
public boolean
public boolean
public @NotNull TrackedOffset
plusOffsetDelta(int delta)

public void
setIndex(int index)

public void
setSpacesAfter(int spacesAfter)

public void
setSpacesBefore(int spacesBefore)

public void
setSpliced(boolean spliced)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public static TrackedOffset
public static TrackedOffset
track(int offset)

public static TrackedOffset
track(int offset, @Nullable Character c, boolean afterDelete)

public static TrackedOffset
track(int offset, boolean afterSpaceEdit, boolean afterInsert, boolean afterDelete)

public @NotNull TrackedOffset
withOffset(int offset)

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

F_AFTER_DELETEback to summary
private static final int F_AFTER_DELETE
F_AFTER_INSERTback to summary
private static final int F_AFTER_INSERT
F_AFTER_SPACE_EDITback to summary
private static final int F_AFTER_SPACE_EDIT
flagsback to summary
private final int flags
indexback to summary
private int index
isSplicedback to summary
private boolean isSpliced
offsetback to summary
private final int offset
originalback to summary
private final @Nullable TrackedOffset original
Annotations
@Nullable
spacesAfterback to summary
private int spacesAfter
spacesBeforeback to summary
private int spacesBefore

Constructor Detail

TrackedOffsetback to summary
private TrackedOffset(int offset, boolean afterSpaceEdit, boolean afterInsert, boolean afterDelete)
TrackedOffsetback to summary
private TrackedOffset(@NotNull TrackedOffset other)
TrackedOffsetback to summary
private TrackedOffset(@NotNull TrackedOffset other, int offset)

Method Detail

compareToback to summary
public int compareTo(@NotNull TrackedOffset o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
o:@NotNull TrackedOffset

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
compareToback to summary
public int compareTo(@NotNull Integer o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
o:@NotNull Integer

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

compareToback to summary
public int compareTo(int offset)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
offset:int

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

equalsback to summary
public boolean equals(Object o)

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.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getIndexback to summary
public int getIndex()
getOffsetback to summary
public int getOffset()
getSpacesAfterback to summary
public int getSpacesAfter()
getSpacesBeforeback to summary
public int getSpacesBefore()
hashCodeback 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.
Returns:int

a hash code value for this object

Annotations
@Override
isAfterDeleteback to summary
public boolean isAfterDelete()
isAfterInsertback to summary
public boolean isAfterInsert()
isAfterSpaceEditback to summary
public boolean isAfterSpaceEdit()
isResolvedback to summary
public boolean isResolved()
isSplicedback to summary
public boolean isSpliced()
plusOffsetDeltaback to summary
public @NotNull TrackedOffset plusOffsetDelta(int delta)
Annotations
@NotNull
setIndexback to summary
public void setIndex(int index)
setSpacesAfterback to summary
public void setSpacesAfter(int spacesAfter)
setSpacesBeforeback to summary
public void setSpacesBefore(int spacesBefore)
setSplicedback to summary
public void setSpliced(boolean spliced)
toStringback to summary
public 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.

Returns:String

a string representation of the object

Annotations
@Override
trackback to summary
public static TrackedOffset track(@NotNull TrackedOffset other)
trackback to summary
public static TrackedOffset track(int offset)
trackback to summary
public static TrackedOffset track(int offset, @Nullable Character c, boolean afterDelete)
Annotations
@SuppressWarnings:UnusedReturnValue
trackback to summary
public static TrackedOffset track(int offset, boolean afterSpaceEdit, boolean afterInsert, boolean afterDelete)
withOffsetback to summary
public @NotNull TrackedOffset withOffset(int offset)
Annotations
@NotNull
com.vladsch.flexmark.util.format back to summary

private final Enum TrackedOffset.Flags

extends Enum<TrackedOffset.Flags>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final TrackedOffset.Flags
public static final TrackedOffset.Flags
public static final TrackedOffset.Flags

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static TrackedOffset.Flags
public static TrackedOffset.Flags[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

AFTER_DELETEback to summary
public static final TrackedOffset.Flags AFTER_DELETE
AFTER_INSERTback to summary
public static final TrackedOffset.Flags AFTER_INSERT
AFTER_SPACE_EDITback to summary
public static final TrackedOffset.Flags AFTER_SPACE_EDIT

Constructor Detail

Flagsback to summary
private Flags()

Method Detail

valueOfback to summary
public static TrackedOffset.Flags valueOf(String name)
valuesback to summary
public static TrackedOffset.Flags[] values()