org.brapi.v2.model.geno

Enum BrAPIFileFormatEnum

java.lang.Object

java.lang.Enum<BrAPIFileFormatEnum>

org.brapi.v2.model.geno.BrAPIFileFormatEnum

All Implemented Interfaces:

Serializable, Comparable<BrAPIFileFormatEnum>, BrAPIEnum

public enum BrAPIFileFormatEnum
extends Enum<BrAPIFileFormatEnum>
implements BrAPIEnum

fileFormat defines the MIME type of the file (ie text/csv, application/excel, application/zip). This should also be reflected in the Accept and ContentType HTTP headers for every relevant request and response.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPLICATION_EXCEL
APPLICATION_JSON
APPLICATION_ZIP
TEXT_CSV
TEXT_TSV

Method Summary

Modifier and Type	Method and Description
static BrAPIFileFormatEnum	fromValue(String input)
String	getBrapiValue()
String	getValue()
String	toString()
static BrAPIFileFormatEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static BrAPIFileFormatEnum[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TEXT_CSV

public static final BrAPIFileFormatEnum TEXT_CSV

TEXT_TSV

public static final BrAPIFileFormatEnum TEXT_TSV

APPLICATION_EXCEL

public static final BrAPIFileFormatEnum APPLICATION_EXCEL

APPLICATION_ZIP

public static final BrAPIFileFormatEnum APPLICATION_ZIP

APPLICATION_JSON

public static final BrAPIFileFormatEnum APPLICATION_JSON

Method Detail

values

public static BrAPIFileFormatEnum[] 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 (BrAPIFileFormatEnum c : BrAPIFileFormatEnum.values())
    System.out.println(c);

Returns:

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

valueOf

public static BrAPIFileFormatEnum 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

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<BrAPIFileFormatEnum>

fromValue

public static BrAPIFileFormatEnum fromValue(String input)

getBrapiValue

public String getBrapiValue()

Specified by:

getBrapiValue in interface BrAPIEnum