Package org.basex.io.serial

Enum SerializerMode

java.lang.Object

java.lang.Enum<SerializerMode>

org.basex.io.serial.SerializerMode

All Implemented Interfaces:

Serializable, Comparable<SerializerMode>

public enum SerializerMode
extends Enum<SerializerMode>

Pre-defined serialization parameters.

Author:

BaseX Team 2005-24, BSD License, Christian Gruen

Enum Constant Summary

Enum Constants

Enum Constant	Description
API	API result retrieval.
DEBUG	Debugging (adaptive method).
DEFAULT	Default serialization.
INDENT	Default serialization with indentation.

Method Summary

Modifier and Type	Method	Description
SerializerOptions	get()	Returns serialization parameters.
static SerializerMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SerializerMode[]	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 Detail

DEFAULT

public static final SerializerMode DEFAULT

Default serialization.

INDENT

public static final SerializerMode INDENT

Default serialization with indentation.

DEBUG

public static final SerializerMode DEBUG

Debugging (adaptive method).

API

public static final SerializerMode API

API result retrieval. Also used by XQJ.

Method Detail

values

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

Returns:

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

valueOf

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

get

public final SerializerOptions get()

Returns serialization parameters.

Returns:

parameters