Package org.variantsync.diffdetective.variation.tree.view.relevance.spec

Record Class ConfigureSpec

java.lang.Object

java.lang.Record

org.variantsync.diffdetective.variation.tree.view.relevance.spec.ConfigureSpec

All Implemented Interfaces:

Predicate<VariationNode<?,?>>, Source, Relevance

public record ConfigureSpec(FixTrueFalse.Formula config)
extends Record
implements Relevance

This class serves as a specification for Configure. Both classes must act semantically equivalent as a Relevance predicate. Whereas Configure is an implementation optimized to avoid SAT calls where necessary, the implementation in ConfigureSpec is kept simple by design to remain verifiable. ConfigureSpec tests a partial configuration against a variation tree or diff by checking each node individually. To this end ConfigureSpec uses the default, naive implementations of Relevance instead of providing optimized implementations for tree traversal as Configure does. This class is not intended for production use and rather is supposed to be used in tests.

Author:

Paul Bittner

Field Summary

Fields

Modifier and Type	Field	Description
private final FixTrueFalse.Formula	config	The field for the config record component.

Fields inherited from interface org.variantsync.diffdetective.util.Source

Unknown

Constructor Summary

Constructors

Constructor	Description
ConfigureSpec(org.prop4j.Node configuration)
ConfigureSpec(FixTrueFalse.Formula config)	Creates an instance of a ConfigureSpec record class.

Method Summary

Modifier and Type	Method	Description
FixTrueFalse.Formula	config()	Returns the value of the config record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<Object>	getSourceArguments()	Returns a list of arguments required to understand this source.
String	getSourceExplanation()	Returns a short, one line explanation or identifier of this source.
final int	hashCode()	Returns a hash code value for this object.
static boolean	test(FixTrueFalse.Formula formula, VariationNode<?,?> v)
boolean	test(VariationNode<?,?> t)
String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, negate, or

Methods inherited from interface org.variantsync.diffdetective.variation.tree.view.relevance.Relevance

computeViewNodes

Methods inherited from interface org.variantsync.diffdetective.util.Source

fullExplanation, functionExplanation, getRootSource, getSources, shallowExplanation

Field Details

config

private final FixTrueFalse.Formula config

The field for the config record component.

Constructor Details

ConfigureSpec

public ConfigureSpec(org.prop4j.Node configuration)

ConfigureSpec

public ConfigureSpec(FixTrueFalse.Formula config)

Creates an instance of a ConfigureSpec record class.

Parameters:

config - the value for the config record component

Method Details

test

public static boolean test(FixTrueFalse.Formula formula,
 VariationNode<?,?> v)

test

public boolean test(VariationNode<?,?> t)

Specified by:

test in interface Predicate<VariationNode<?,?>>

getSourceArguments

public List<Object> getSourceArguments()

Description copied from interface: Source

Returns a list of arguments required to understand this source. Each argument in the result list should represent a string without newlines and will be formatted together with Source.getSourceExplanation() like "sourceExplanation(argument1, argument2)" by Source.shallowExplanation(). This method is only intended to access the arguments for printing. In case access to the well-typed object is required, use Source.<T>findFirst(org.variantsync.diffdetective.util.Source,java.lang.Class<T>) or Source.<T>findAll(org.variantsync.diffdetective.util.Source,java.lang.Class<T>) and use the accessors of the underlying type.

For ease of implementing Source, the return value is a list of Objects instead of a list of Strings to allow code like List.of(arg0, arg1, arg2) instead of List.of(arg0.toString(), arg1.toString(), arg2.toString()). Users of this function should assume nothing from the returned objects except that Object.toString() is well behaved.

Specified by:

getSourceArguments in interface Source

Returns:

an empty list by default

See Also:

• Source.shallowExplanation()

getSourceExplanation

public String getSourceExplanation()

Description copied from interface: Source

Returns a short, one line explanation or identifier of this source. The result is used by Source.shallowExplanation() and is formatted together with Source.getSourceArguments() like "sourceExplanation(argument1, argument2)".

Specified by:

getSourceExplanation in interface Source

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.

config

public FixTrueFalse.Formula config()

Returns the value of the config record component.

Returns:

the value of the config record component