Record Class PacketAssembler.TopicEntry

java.lang.Object

java.lang.Record

network.ike.docs.plugin.diff.PacketAssembler.TopicEntry

Record Components:

change - the underlying file change

outName - the flattened file name of the marked copy under _diff/

result - the marker's output for this topic

Enclosing class:

PacketAssembler

public static record PacketAssembler.TopicEntry(GitSource.Change change, String outName, AdocDiffMarker.MarkResult result)
extends Record

One marked topic destined for the packet.

Constructor Summary

Constructors

Constructor	Description
TopicEntry(GitSource.Change change, String outName, AdocDiffMarker.MarkResult result)	Creates an instance of a TopicEntry record class.

Method Summary

Modifier and Type	Method	Description
GitSource.Change	change()	Returns the value of the change 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.
String	outName()	Returns the value of the outName record component.
AdocDiffMarker.MarkResult	result()	Returns the value of the result 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

TopicEntry

public TopicEntry(GitSource.Change change,
 String outName,
 AdocDiffMarker.MarkResult result)

Creates an instance of a TopicEntry record class.

Parameters:

change - the value for the change record component

outName - the value for the outName record component

result - the value for the result 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. All components in this record class are compared with Objects::equals(Object,Object).

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.

change

public GitSource.Change change()

Returns the value of the change record component.

Returns:

the value of the change record component

outName

public String outName()

Returns the value of the outName record component.

Returns:

the value of the outName record component

result

public AdocDiffMarker.MarkResult result()

Returns the value of the result record component.

Returns:

the value of the result record component