Module org.phenopackets.phenopackettools.core

Package org.phenopackets.phenopackettools.core

Enum Class PhenopacketFormat

java.lang.Object

java.lang.Enum<PhenopacketFormat>

org.phenopackets.phenopackettools.core.PhenopacketFormat

All Implemented Interfaces:

Serializable, Comparable<PhenopacketFormat>, Constable

public enum PhenopacketFormat
extends Enum<PhenopacketFormat>

The enum members represent the supported representations of the top-level elements of the Phenopacket schema.

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
JSON
PROTOBUF
YAML

Method Summary

Modifier and Type	Method	Description
static PhenopacketFormat	parse(String value)
String	suffix()	Get file name suffix for the given PhenopacketFormat (e.g.
String	toString()
static PhenopacketFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PhenopacketFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PROTOBUF

public static final PhenopacketFormat PROTOBUF

JSON

public static final PhenopacketFormat JSON

YAML

public static final PhenopacketFormat YAML

Method Details

values

public static PhenopacketFormat[] values()

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

Returns:

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

valueOf

public static PhenopacketFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

suffix

public String suffix()

Get file name suffix for the given PhenopacketFormat (e.g. .json for JSON).

toString

public String toString()

Overrides:

toString in class Enum<PhenopacketFormat>

parse

public static PhenopacketFormat parse(String value)