Package org.rcsb.strucmotif.domain.motif

Enum Overlap

java.lang.Object

java.lang.Enum<Overlap>

org.rcsb.strucmotif.domain.motif.Overlap

All Implemented Interfaces:

Serializable, Comparable<Overlap>, java.lang.constant.Constable, BiPredicate<InvertedIndexResiduePairIdentifier,InvertedIndexResiduePairIdentifier>

public enum Overlap
extends Enum<Overlap>
implements BiPredicate<InvertedIndexResiduePairIdentifier,InvertedIndexResiduePairIdentifier>

Describes the overlap between two ResiduePairIdentifier instances. Done by determining whether LabelSelection instances equal. Can be no overlap or both overlapping. Interesting case is when 1 pair overlaps. Can be LEFT_LEFT (left/first identifier of first word paired to left/first of second word) and so on.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTH	Both sides overlap.
LEFT_LEFT	Left identifier of first word corresponds to left identifier of second word.
LEFT_RIGHT	Left identifier of first word corresponds to right identifier of second word.
NONE	No overlap.
RIGHT_LEFT	Right identifier of first word corresponds to left identifier of second word.
RIGHT_RIGHT	Right identifier of first word corresponds to right identifier of second word.

Method Summary

Modifier and Type	Method	Description
static Overlap	ofResiduePairIdentifiers(IndexResiduePairIdentifier residuePairIdentifier1, IndexResiduePairIdentifier residuePairIdentifier2)	Determines the overlap between 2 IndexResiduePairIdentifier instances.
boolean	test(InvertedIndexResiduePairIdentifier residuePairIdentifier1, InvertedIndexResiduePairIdentifier residuePairIdentifier2)
static Overlap	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Overlap[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.BiPredicate

and, negate, or

Enum Constant Details

NONE

public static final Overlap NONE

No overlap.

LEFT_LEFT

public static final Overlap LEFT_LEFT

Left identifier of first word corresponds to left identifier of second word.

LEFT_RIGHT

public static final Overlap LEFT_RIGHT

Left identifier of first word corresponds to right identifier of second word.

RIGHT_LEFT

public static final Overlap RIGHT_LEFT

Right identifier of first word corresponds to left identifier of second word.

RIGHT_RIGHT

public static final Overlap RIGHT_RIGHT

Right identifier of first word corresponds to right identifier of second word.

BOTH

public static final Overlap BOTH

Both sides overlap.

Method Details

values

public static Overlap[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Overlap valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

test

public boolean test(InvertedIndexResiduePairIdentifier residuePairIdentifier1,
 InvertedIndexResiduePairIdentifier residuePairIdentifier2)

Specified by:

test in interface BiPredicate<InvertedIndexResiduePairIdentifier,InvertedIndexResiduePairIdentifier>

ofResiduePairIdentifiers

public static Overlap ofResiduePairIdentifiers(IndexResiduePairIdentifier residuePairIdentifier1,
 IndexResiduePairIdentifier residuePairIdentifier2)

Determines the overlap between 2 IndexResiduePairIdentifier instances.

Parameters:

residuePairIdentifier1 - the first instance

residuePairIdentifier2 - the second instance

Returns:

a description of the observed overlap