Package org.brapi.schematools.cli

Enum Class OutputFormat

java.lang.Object

java.lang.Enum<OutputFormat>

org.brapi.schematools.cli.OutputFormat

All Implemented Interfaces:

Serializable, Comparable<OutputFormat>, Constable

public enum OutputFormat
extends Enum<OutputFormat>

Enumeration that provides the possible outputs for generator

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
GRAPHQL	Use this format to generate a GraphQL schema
MARKDOWN	Use this format to generate Markdown for type and their field descriptions
OPEN_API	Use this format to generate an OpenAPI specification
OWL	Use this format to generate OWL specification in turtle format
XLSX	Use this format to generate Excel (xlsx) for types and their field descriptions

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OPEN_API

public static final OutputFormat OPEN_API

Use this format to generate an OpenAPI specification

GRAPHQL

public static final OutputFormat GRAPHQL

Use this format to generate a GraphQL schema

OWL

public static final OutputFormat OWL

Use this format to generate OWL specification in turtle format

MARKDOWN

public static final OutputFormat MARKDOWN

Use this format to generate Markdown for type and their field descriptions

XLSX

public static final OutputFormat XLSX

Use this format to generate Excel (xlsx) for types and their field descriptions

Method Details

values

public static OutputFormat[] 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 OutputFormat 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