htsjdk.beta.plugin.interval

Enum HtsQueryRule

java.lang.Object

java.lang.Enum<HtsQueryRule>

htsjdk.beta.plugin.interval.HtsQueryRule

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HtsQueryRule>

public enum HtsQueryRule
extends java.lang.Enum<HtsQueryRule>

Query rule values used to determine signal whether a query should match overlapping or contained records. For use with HtsQuery methods.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTAINED Only get records that are entirely contained with the query interval.
OVERLAPPING Get all records that overlap the query interval.

Method Summary

Modifier and Type	Method and Description
static HtsQueryRule	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HtsQueryRule[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OVERLAPPING

public static final HtsQueryRule OVERLAPPING

Get all records that overlap the query interval.

CONTAINED

public static final HtsQueryRule CONTAINED

Only get records that are entirely contained with the query interval.

Method Detail

values

public static HtsQueryRule[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HtsQueryRule c : HtsQueryRule.values())
    System.out.println(c);

Returns:

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

valueOf

public static HtsQueryRule valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null