Module dev.metaschema.databind

Package dev.metaschema.databind.io

Enum Format

java.lang.Object

java.lang.Enum<Format>

dev.metaschema.databind.io.Format

All Implemented Interfaces:

Serializable, Comparable<Format>

public enum Format
extends Enum<Format>

Selections of serialization formats.

Enum Constant Summary

Enum Constants

Enum Constant	Description
JSON	The JavaScript Object Notation format.
XML	The Extensible Markup Language format.
YAML	The YAML Ain't Markup Language format.

Method Summary

Modifier and Type	Method	Description
String	getDefaultExtension()	Get the default extension to use for the format.
IPathFormatter	getPathFormatter()	Get the appropriate path formatter for this format.
Set<String>	getRecognizedExtensions()	Get the default extension to use for the format.
static List<String>	names()	Get a list of all format names in lowercase.
static IPathFormatter	resolvePathFormatter(PathFormatSelection selection, Format format)	Resolve the path formatter based on the selection and document format.
static Format	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Format[]	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 Details

XML

public static final Format XML

The Extensible Markup Language format.

JSON

public static final Format JSON

The JavaScript Object Notation format.

YAML

public static final Format YAML

The YAML Ain't Markup Language format.

Method Details

values

public static Format[] values()

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

Returns:

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

valueOf

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

names

public static List<String> names()

Get a list of all format names in lowercase.

Returns:

the list of names

getRecognizedExtensions

@NonNull
public Set<String> getRecognizedExtensions()

Get the default extension to use for the format.

Returns:

the default extension

getDefaultExtension

@NonNull
public String getDefaultExtension()

Get the default extension to use for the format.

Returns:

the default extension

getPathFormatter

@NonNull
public IPathFormatter getPathFormatter()

Get the appropriate path formatter for this format.

Returns:

• IPathFormatter.XPATH_PATH_FORMATTER for XML
• IPathFormatter.JSON_POINTER_PATH_FORMATTER for JSON and YAML

Returns:

the path formatter appropriate for this format

resolvePathFormatter

@NonNull
public static IPathFormatter resolvePathFormatter(@NonNull
 PathFormatSelection selection,
 @Nullable
 Format format)

Resolve the path formatter based on the selection and document format.

When PathFormatSelection.AUTO is specified, the formatter is determined by the document format. For explicit selections, the corresponding formatter is returned regardless of document format.

Parameters:

selection - the path format selection

format - the document format, used when selection is AUTO; may be null

Returns:

the resolved path formatter