Package org.variantsync.diffdetective.variation.tree

Record Class VariationTree<L extends Label>

java.lang.Object

java.lang.Record

org.variantsync.diffdetective.variation.tree.VariationTree<L>

Type Parameters:

L - The type of label stored in this tree.

Record Components:

root - the root of the variation tree

source - from which source code the variation tree was obtained

public record VariationTree<L extends Label>(VariationTreeNode<L extends Label> root, VariationTreeSource source)
extends Record

Representation of a concrete variation tree with source information.

Author:

Benjamin Moosherr

See Also:

• VariationTreeNode

Field Summary

Fields

Modifier and Type	Field	Description
private final VariationTreeNode<L>	root	The field for the root record component.
private final VariationTreeSource	source	The field for the source record component.

Constructor Summary

Constructors

Constructor	Description
VariationTree(VariationTreeNode<L> root)	Creates a VariationTree with the given root and an unknown source.
VariationTree(VariationTreeNode<L> root, VariationTreeSource source)	Creates a VariationTree with the given root and source.

Method Summary

Modifier and Type	Method	Description
boolean	anyMatch(Predicate<VariationTreeNode<L>> condition)	Checks whether any node in this tree satisfies the given condition.
int	computeSize()	Returns the number of nodes in this Variation Tree.
boolean	contains(VariationTreeNode<L> node)	Returns true iff this tree contains the given node.
VariationTree<L>	deepCopy()
VariationTree<L>	deepCopy(Map<VariationTreeNode<L>,VariationTreeNode<L>> oldToNew)	Creates a deep copy of this variation tree.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
VariationTree<L>	forAllPreorder(Consumer<VariationTreeNode<L>> action)	Invokes the given callback for each node in this Variation Tree in depth-first order.
static VariationTree<DiffLinesLabel>	fromFile(BufferedReader input, VariationTreeSource source, VariationDiffParseOptions parseOptions)	Parses a VariationTree from source code with C preprocessor annotations.
static VariationTree<DiffLinesLabel>	fromFile(Path path)	Same as fromFile(Path, VariationDiffParseOptions) but with VariationDiffParseOptions.Default parse options.
static VariationTree<DiffLinesLabel>	fromFile(Path path, VariationDiffParseOptions parseOptions)	Same as fromFile(BufferedReader, VariationTreeSource, VariationDiffParseOptions) but registers path as source.
static <L extends Label> VariationTree<L>	fromProjection(Projection<L> projection, VariationTreeSource source)
static <T extends VariationNode<T, L>, L extends Label> VariationTree<L>	fromVariationNode(VariationNode<T,L> node, VariationTreeSource source)
final int	hashCode()	Returns a hash code value for this object.
VariationTreeNode<L>	root()	Returns the value of the root record component.
VariationTreeSource	source()	Returns the value of the source record component.
VariationDiff<L>	toCompletelyUnchangedVariationDiff()
String	toString()	Returns a string representation of this record class.
VariationDiff<L>	toVariationDiff(Function<VariationTreeNode<L>,DiffNode<L>> nodeConverter)

Methods inherited from class java.lang.Object

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

Field Details

root

private final VariationTreeNode<L extends Label> root

The field for the root record component.

source

private final VariationTreeSource source

The field for the source record component.

Constructor Details

VariationTree

public VariationTree(VariationTreeNode<L> root)

Creates a VariationTree with the given root and an unknown source.

VariationTree

public VariationTree(VariationTreeNode<L> root,
 VariationTreeSource source)

Creates a VariationTree with the given root and source.

Method Details

fromFile

public static VariationTree<DiffLinesLabel> fromFile(Path path)
                                              throws IOException,
DiffParseException

Same as fromFile(Path, VariationDiffParseOptions) but with VariationDiffParseOptions.Default parse options.

Throws:

IOException

DiffParseException

fromFile

public static VariationTree<DiffLinesLabel> fromFile(Path path,
 VariationDiffParseOptions parseOptions)
                                              throws IOException,
DiffParseException

Same as fromFile(BufferedReader, VariationTreeSource, VariationDiffParseOptions) but registers path as source.

Throws:

IOException

DiffParseException

fromFile

public static VariationTree<DiffLinesLabel> fromFile(BufferedReader input,
 VariationTreeSource source,
 VariationDiffParseOptions parseOptions)
                                              throws IOException,
DiffParseException

Parses a VariationTree from source code with C preprocessor annotations.

Parameters:

input - the source code to be parsed

parseOptions - PatchDiffParseOptions for the parsing process.

Returns:

a new VariationTree representing input

Throws:

IOException - if input throws IOException

DiffParseException - if some preprocessor annotations can't be parsed

fromProjection

public static <L extends Label> VariationTree<L> fromProjection(Projection<L> projection,
 VariationTreeSource source)

fromVariationNode

public static <T extends VariationNode<T,
L>,
L extends Label>
VariationTree<L> fromVariationNode(VariationNode<T,L> node,
 VariationTreeSource source)

toVariationDiff

public VariationDiff<L> toVariationDiff(Function<VariationTreeNode<L>,DiffNode<L>> nodeConverter)

toCompletelyUnchangedVariationDiff

public VariationDiff<L> toCompletelyUnchangedVariationDiff()

forAllPreorder

public VariationTree<L> forAllPreorder(Consumer<VariationTreeNode<L>> action)

Invokes the given callback for each node in this Variation Tree in depth-first order.

Parameters:

action - callback

Returns:

this

anyMatch

public boolean anyMatch(Predicate<VariationTreeNode<L>> condition)

Checks whether any node in this tree satisfies the given condition. The condition might not be invoked on every node in case a node is found.

Parameters:

condition - A condition to check on each node.

Returns:

True iff the given condition returns true for at least one node in this tree.

contains

public boolean contains(VariationTreeNode<L> node)

Returns true iff this tree contains the given node. Containment check is done on referential and not on textual equality (i.e., nodes are compared using ==).

Parameters:

node - The node to check for containment.

computeSize

public int computeSize()

Returns the number of nodes in this Variation Tree.

deepCopy

public VariationTree<L> deepCopy()

deepCopy

public VariationTree<L> deepCopy(Map<VariationTreeNode<L>,VariationTreeNode<L>> oldToNew)

Creates a deep copy of this variation tree.

The map oldToNew should be empty as it will be filled by this method. After the method call, the map keys will contain all nodes in this tree. The corresponding values will be the nodes in the returned tree, where each pair (k, v) denotes that v was cloned from k.

Parameters:

oldToNew - A map that memorizes the translation of individual nodes.

Returns:

A deep copy of this tree.

toString

public 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.

root

public VariationTreeNode<L> root()

Returns the value of the root record component.

Returns:

the value of the root record component

source

public VariationTreeSource source()

Returns the value of the source record component.

Returns:

the value of the source record component