Package org.variantsync.diffdetective.variation.diff.serialize

Record Class LineGraphExportOptions<L extends Label>

java.lang.Object

java.lang.Record

org.variantsync.diffdetective.variation.diff.serialize.LineGraphExportOptions<L>

Record Components:

graphFormat - GraphFormat

treeFormat - VariationDiffLabelFormat

nodeFormat - DiffNodeLabelFormat

edgeFormat - EdgeLabelFormat

onError - Callback that is invoked when an error occurs.

public record LineGraphExportOptions<L extends Label>(GraphFormat graphFormat, VariationDiffLabelFormat treeFormat, DiffNodeLabelFormat<? super L extends Label> nodeFormat, EdgeLabelFormat<? super L extends Label> edgeFormat, BiConsumer<PatchDiff,Exception> onError)
extends Record

Options necessary for exporting a line graph. This records contains information for exporting a VariationDiff into a line graph, such as the graph format and tree and node layouts.

Author:

Paul Bittner

Field Summary

Fields

Modifier and Type	Field	Description
private final EdgeLabelFormat<? super L>	edgeFormat	The field for the edgeFormat record component.
private final GraphFormat	graphFormat	The field for the graphFormat record component.
private final DiffNodeLabelFormat<? super L>	nodeFormat	The field for the nodeFormat record component.
private final BiConsumer<PatchDiff,Exception>	onError	The field for the onError record component.
private final VariationDiffLabelFormat	treeFormat	The field for the treeFormat record component.

Constructor Summary

Constructors

Constructor	Description
LineGraphExportOptions(GraphFormat graphFormat, VariationDiffLabelFormat treeFormat, DiffNodeLabelFormat<? super L> nodeFormat, EdgeLabelFormat<? super L> edgeFormat)	Creates a export options with a neutral filter (that accepts all trees), no transformers, and that logs errors.
LineGraphExportOptions(GraphFormat graphFormat, VariationDiffLabelFormat treeFormat, DiffNodeLabelFormat<? super L> nodeFormat, EdgeLabelFormat<? super L> edgeFormat, BiConsumer<PatchDiff,Exception> onError)	Creates an instance of a LineGraphExportOptions record class.
LineGraphExportOptions(LineGraphImportOptions<? super L> importOptions)	Create export options from the given import options.

Method Summary

Modifier and Type	Method	Description
EdgeLabelFormat<? super L>	edgeFormat()	Returns the value of the edgeFormat record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
GraphFormat	graphFormat()	Returns the value of the graphFormat record component.
final int	hashCode()	Returns a hash code value for this object.
static BiConsumer<PatchDiff,Exception>	LogError()	Default value for onError that logs errors.
DiffNodeLabelFormat<? super L>	nodeFormat()	Returns the value of the nodeFormat record component.
BiConsumer<PatchDiff,Exception>	onError()	Returns the value of the onError record component.
static BiConsumer<PatchDiff,Exception>	RenderError()	Default value for onError that renders errors with PatchDiffRenderer.ErrorRendering(org.variantsync.diffdetective.variation.diff.render.VariationDiffRenderer) (with VariationDiffRenderer.WithinDiffDetective().
static BiConsumer<PatchDiff,Exception>	SysExitOnError()	Default value for onError that exits the program immediately upon an error with System.exit(int).
final String	toString()	Returns a string representation of this record class.
VariationDiffLabelFormat	treeFormat()	Returns the value of the treeFormat record component.

Methods inherited from class java.lang.Object

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

Field Details

graphFormat

private final GraphFormat graphFormat

The field for the graphFormat record component.

treeFormat

private final VariationDiffLabelFormat treeFormat

The field for the treeFormat record component.

nodeFormat

private final DiffNodeLabelFormat<? super L extends Label> nodeFormat

The field for the nodeFormat record component.

edgeFormat

private final EdgeLabelFormat<? super L extends Label> edgeFormat

The field for the edgeFormat record component.

onError

private final BiConsumer<PatchDiff,Exception> onError

The field for the onError record component.

Constructor Details

LineGraphExportOptions

public LineGraphExportOptions(GraphFormat graphFormat,
 VariationDiffLabelFormat treeFormat,
 DiffNodeLabelFormat<? super L> nodeFormat,
 EdgeLabelFormat<? super L> edgeFormat)

Creates a export options with a neutral filter (that accepts all trees), no transformers, and that logs errors.

LineGraphExportOptions

public LineGraphExportOptions(LineGraphImportOptions<? super L> importOptions)

Create export options from the given import options. Invokes LineGraphExportOptions(GraphFormat, VariationDiffLabelFormat, DiffNodeLabelFormat, EdgeLabelFormat) with all formats from the given import options.

Parameters:

importOptions - The import options to convert to export options.

LineGraphExportOptions

public LineGraphExportOptions(GraphFormat graphFormat,
 VariationDiffLabelFormat treeFormat,
 DiffNodeLabelFormat<? super L> nodeFormat,
 EdgeLabelFormat<? super L> edgeFormat,
 BiConsumer<PatchDiff,Exception> onError)

Creates an instance of a LineGraphExportOptions record class.

Parameters:

graphFormat - the value for the graphFormat record component

treeFormat - the value for the treeFormat record component

nodeFormat - the value for the nodeFormat record component

edgeFormat - the value for the edgeFormat record component

onError - the value for the onError record component

Method Details

LogError

public static BiConsumer<PatchDiff,Exception> LogError()

Default value for onError that logs errors.

RenderError

public static BiConsumer<PatchDiff,Exception> RenderError()

Default value for onError that renders errors with PatchDiffRenderer.ErrorRendering(org.variantsync.diffdetective.variation.diff.render.VariationDiffRenderer) (with VariationDiffRenderer.WithinDiffDetective().

SysExitOnError

public static BiConsumer<PatchDiff,Exception> SysExitOnError()

Default value for onError that exits the program immediately upon an error with System.exit(int).

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.

graphFormat

public GraphFormat graphFormat()

Returns the value of the graphFormat record component.

Returns:

the value of the graphFormat record component

treeFormat

public VariationDiffLabelFormat treeFormat()

Returns the value of the treeFormat record component.

Returns:

the value of the treeFormat record component

nodeFormat

public DiffNodeLabelFormat<? super L> nodeFormat()

Returns the value of the nodeFormat record component.

Returns:

the value of the nodeFormat record component

edgeFormat

public EdgeLabelFormat<? super L> edgeFormat()

Returns the value of the edgeFormat record component.

Returns:

the value of the edgeFormat record component

onError

public BiConsumer<PatchDiff,Exception> onError()

Returns the value of the onError record component.

Returns:

the value of the onError record component