Record Class AdocDiffMarker.MarkResult

java.lang.Object

java.lang.Record

network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult

Record Components:

lines - the marked fragment, line by line, including the injected change-summary note block

insWords - approximate count of inserted words

delWords - approximate count of deleted words

notes - human-readable notes for changes the marker could not show inline

Enclosing class:

AdocDiffMarker

public static record AdocDiffMarker.MarkResult(List<String> lines, int insWords, int delWords, List<String> notes)
extends Record

The result of marking one fragment: the marked lines, word-level insertion/deletion counts, and the notes describing changes to protected constructs.

Constructor Summary

Constructors

Constructor	Description
MarkResult(List<String> lines, int insWords, int delWords, List<String> notes)	Creates an instance of a MarkResult record class.

Method Summary

Modifier and Type	Method	Description
int	delWords()	Returns the value of the delWords record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	insWords()	Returns the value of the insWords record component.
List<String>	lines()	Returns the value of the lines record component.
List<String>	notes()	Returns the value of the notes record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MarkResult

public MarkResult(List<String> lines,
 int insWords,
 int delWords,
 List<String> notes)

Creates an instance of a MarkResult record class.

Parameters:

lines - the value for the lines record component

insWords - the value for the insWords record component

delWords - the value for the delWords record component

notes - the value for the notes record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

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

lines

public List<String> lines()

Returns the value of the lines record component.

Returns:

the value of the lines record component

insWords

public int insWords()

Returns the value of the insWords record component.

Returns:

the value of the insWords record component

delWords

public int delWords()

Returns the value of the delWords record component.

Returns:

the value of the delWords record component

notes

public List<String> notes()

Returns the value of the notes record component.

Returns:

the value of the notes record component