Package picard.sam
Enum FilterSamReads.Filter
- java.lang.Object
-
- java.lang.Enum<FilterSamReads.Filter>
-
- picard.sam.FilterSamReads.Filter
-
- All Implemented Interfaces:
Serializable
,Comparable<FilterSamReads.Filter>
,org.broadinstitute.barclay.argparser.CommandLineParser.ClpEnum
- Enclosing class:
- FilterSamReads
protected static enum FilterSamReads.Filter extends Enum<FilterSamReads.Filter> implements org.broadinstitute.barclay.argparser.CommandLineParser.ClpEnum
-
-
Enum Constant Summary
Enum Constants Enum Constant Description excludeAligned
excludeReadList
excludeTagValues
includeAligned
includeJavascript
includePairedIntervals
includeReadList
includeTagValues
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getHelpDoc()
static FilterSamReads.Filter
valueOf(String name)
Returns the enum constant of this type with the specified name.static FilterSamReads.Filter[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
includeAligned
public static final FilterSamReads.Filter includeAligned
-
excludeAligned
public static final FilterSamReads.Filter excludeAligned
-
includeReadList
public static final FilterSamReads.Filter includeReadList
-
excludeReadList
public static final FilterSamReads.Filter excludeReadList
-
includeJavascript
public static final FilterSamReads.Filter includeJavascript
-
includePairedIntervals
public static final FilterSamReads.Filter includePairedIntervals
-
includeTagValues
public static final FilterSamReads.Filter includeTagValues
-
excludeTagValues
public static final FilterSamReads.Filter excludeTagValues
-
-
Method Detail
-
values
public static FilterSamReads.Filter[] 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 (FilterSamReads.Filter c : FilterSamReads.Filter.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FilterSamReads.Filter 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 nameNullPointerException
- if the argument is null
-
getHelpDoc
public String getHelpDoc()
- Specified by:
getHelpDoc
in interfaceorg.broadinstitute.barclay.argparser.CommandLineParser.ClpEnum
-
-