Package com.helger.xml.serialize.write

Enum EXMLSerializeXMLDeclaration

java.lang.Object

java.lang.Enum<EXMLSerializeXMLDeclaration>

com.helger.xml.serialize.write.EXMLSerializeXMLDeclaration

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, Serializable, Comparable<EXMLSerializeXMLDeclaration>

public enum EXMLSerializeXMLDeclaration
extends Enum<EXMLSerializeXMLDeclaration>
implements com.helger.commons.id.IHasID<String>

Used for creating string representation of XML. Determines whether the XML declaration (<?xml version=... encoding=...?>) should be emitted or ignored.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMIT	Emit all fields: version, encoding, standalone
EMIT_NO_NEWLINE	Deprecated. in 9.3.5 - use the method in IXMLWriterSettings instead
EMIT_NO_STANDALONE	Emit fields: version, encoding
IGNORE	Do not emit any XML declaration at all

Method Summary

Modifier and Type	Method	Description
static EXMLSerializeXMLDeclaration	getFromIDOrNull(String sID)
String	getID()
boolean	isEmit()
boolean	isEmitStandalone()
boolean	isWithNewLine()	Deprecated. in 9.3.5 - use the method in IXMLWriterSettings instead
static EXMLSerializeXMLDeclaration	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EXMLSerializeXMLDeclaration[]	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

EMIT

public static final EXMLSerializeXMLDeclaration EMIT

Emit all fields: version, encoding, standalone

EMIT_NO_STANDALONE

public static final EXMLSerializeXMLDeclaration EMIT_NO_STANDALONE

Emit fields: version, encoding

EMIT_NO_NEWLINE

@Deprecated
public static final EXMLSerializeXMLDeclaration EMIT_NO_NEWLINE

Deprecated.

in 9.3.5 - use the method in IXMLWriterSettings instead

Since:

9.2.1

IGNORE

public static final EXMLSerializeXMLDeclaration IGNORE

Do not emit any XML declaration at all

Method Detail

values

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

Returns:

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

valueOf

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

getID

@Nonnull
@Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

isEmit

public boolean isEmit()

Returns:

true it emit is enabled

isWithNewLine

@Deprecated
public boolean isWithNewLine()

Deprecated.

in 9.3.5 - use the method in IXMLWriterSettings instead

Returns:

true if a new line should be emitted afterwards

isEmitStandalone

public boolean isEmitStandalone()

Returns:

true if the "standalone" part of the XML declaration should be printed or not.

getFromIDOrNull

@Nullable
public static EXMLSerializeXMLDeclaration getFromIDOrNull(@Nullable
                                                          String sID)