Package org.variantsync.diffdetective.editclass

Interface EditClassCatalogue

All Known Implementing Classes:

ProposedEditClasses

public interface EditClassCatalogue

Interface for custom catalogs of edit classes.

Author:

Paul Bittner

Method Summary

Modifier and Type	Method	Description
List<EditClass>	all()	Gives a list of all edit classes in this catalogue.
Map<DiffType,List<EditClass>>	byType()	Returns a mapping from diff types to the edit classes that may match nodes of the given diff type.
default EditClass	match(DiffNode<?> node)	Returns the edit class that matches the given node.

Method Details

all

List<EditClass> all()

Gives a list of all edit classes in this catalogue. The list should be constant and immutable (i.e., the very same list is returned each time all is invoked). The edit class should be immutable, too.

Returns:

a constant list of all edit classes in this catalogue.

byType

Map<DiffType,List<EditClass>> byType()

Returns a mapping from diff types to the edit classes that may match nodes of the given diff type. The returned map as well as all its values should be immutable and constant. *

Returns:

A classification of edit classes by their diff types.

match

default EditClass match(DiffNode<?> node)

Returns the edit class that matches the given node. Each node matches exactly one edit class.

Parameters:

node - The node of which to find its edit class.

Returns:

Returns the edit class that matches the given node.