Package org.variantsync.diffdetective.variation.diff.parse

Record Class VariationDiffParseOptions

java.lang.Object

java.lang.Record

org.variantsync.diffdetective.variation.diff.parse.VariationDiffParseOptions

Record Components:

annotationParser - A parser for parsing annotations.

collapseMultipleCodeLines - Whether multiple consecutive code lines with the same diff type should be collapsed into a single artifact node.

ignoreEmptyLines - Whether to add DiffNodes for empty lines (regardless of their DiffType). If collapseMultipleCodeLines is true empty lines are also not added to existing DiffNodes.

public record VariationDiffParseOptions(AnnotationParser annotationParser, boolean collapseMultipleCodeLines, boolean ignoreEmptyLines)
extends Record

Parse options that should be used when parsing VariationDiffs.

Author:

Paul Bittner

Field Summary

Fields

Modifier and Type	Field	Description
private final AnnotationParser	annotationParser	The field for the annotationParser record component.
private final boolean	collapseMultipleCodeLines	The field for the collapseMultipleCodeLines record component.
static final VariationDiffParseOptions	Default	Default value for VariationDiffParseOptions that does not remember parsed unix diffs and uses the default value for the parsing annotations (PreprocessorAnnotationParser.CPPAnnotationParser).
private final boolean	ignoreEmptyLines	The field for the ignoreEmptyLines record component.

Constructor Summary

Constructors

Constructor	Description
VariationDiffParseOptions(boolean collapseMultipleCodeLines, boolean ignoreEmptyLines)	Creates VariationDiffParseOptions with the default parser as specified in Default.
VariationDiffParseOptions(AnnotationParser annotationParser, boolean collapseMultipleCodeLines, boolean ignoreEmptyLines)	Creates an instance of a VariationDiffParseOptions record class.

Method Summary

Modifier and Type	Method	Description
AnnotationParser	annotationParser()	Returns the value of the annotationParser record component.
boolean	collapseMultipleCodeLines()	Returns the value of the collapseMultipleCodeLines 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.
boolean	ignoreEmptyLines()	Returns the value of the ignoreEmptyLines record component.
final String	toString()	Returns a string representation of this record class.
VariationDiffParseOptions	withAnnotationParser(AnnotationParser annotationParser)	Creates VariationDiffParseOptions with the given annotation parser.

Methods inherited from class java.lang.Object

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

Field Details

annotationParser

private final AnnotationParser annotationParser

The field for the annotationParser record component.

collapseMultipleCodeLines

private final boolean collapseMultipleCodeLines

The field for the collapseMultipleCodeLines record component.

ignoreEmptyLines

private final boolean ignoreEmptyLines

The field for the ignoreEmptyLines record component.

Default

public static final VariationDiffParseOptions Default

Default value for VariationDiffParseOptions that does not remember parsed unix diffs and uses the default value for the parsing annotations (PreprocessorAnnotationParser.CPPAnnotationParser).

Constructor Details

VariationDiffParseOptions

public VariationDiffParseOptions(boolean collapseMultipleCodeLines,
 boolean ignoreEmptyLines)

Creates VariationDiffParseOptions with the default parser as specified in Default.

VariationDiffParseOptions

public VariationDiffParseOptions(AnnotationParser annotationParser,
 boolean collapseMultipleCodeLines,
 boolean ignoreEmptyLines)

Creates an instance of a VariationDiffParseOptions record class.

Parameters:

annotationParser - the value for the annotationParser record component

collapseMultipleCodeLines - the value for the collapseMultipleCodeLines record component

ignoreEmptyLines - the value for the ignoreEmptyLines record component

Method Details

withAnnotationParser

public VariationDiffParseOptions withAnnotationParser(AnnotationParser annotationParser)

Creates VariationDiffParseOptions with the given annotation parser.

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 '=='.

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.

annotationParser

public AnnotationParser annotationParser()

Returns the value of the annotationParser record component.

Returns:

the value of the annotationParser record component

collapseMultipleCodeLines

public boolean collapseMultipleCodeLines()

Returns the value of the collapseMultipleCodeLines record component.

Returns:

the value of the collapseMultipleCodeLines record component

ignoreEmptyLines

public boolean ignoreEmptyLines()

Returns the value of the ignoreEmptyLines record component.

Returns:

the value of the ignoreEmptyLines record component