com.levigo.jadice.format.annotation

Class JadiceAnnotationWriterSettings

java.lang.Object

com.levigo.jadice.format.annotation.JadiceAnnotationWriterSettings

All Implemented Interfaces:

ProcessingSettings, SerializableProcessingSettings, WriterSettings, Serializable

public class JadiceAnnotationWriterSettings
extends Object
implements WriterSettings

A settings class for parameters pertaining to the jadice annotation format.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JadiceAnnotationWriterSettings()

Method Summary

Modifier and Type	Method and Description
SerializableProcessingSettings	createSnapshot() Create a snapshot copy of this instance.
boolean	equals(Object o)
String	getEncoding() Set the encoding to be used to read the stream.
int	hashCode()
boolean	isWriteXMLDeclaration() Get whether to include an XML declaration on the stream to be written.
void	setEncoding(String encoding) Set the encoding to be used to read the stream.
void	setWriteXMLDeclaration(boolean writeXMLDeclaration) Set whether to include an XML declaration (e.g.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JadiceAnnotationWriterSettings

public JadiceAnnotationWriterSettings()

Method Detail

createSnapshot

public SerializableProcessingSettings createSnapshot()

Description copied from interface: SerializableProcessingSettings

Create a snapshot copy of this instance. The snapshot must constitute a deep copy, so that changes to the copied object don't affect snapshots.

Specified by:

createSnapshot in interface ProcessingSettings

Specified by:

createSnapshot in interface SerializableProcessingSettings

Returns:

a snapshot copy.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getEncoding

public String getEncoding()

Set the encoding to be used to read the stream.

setEncoding

public void setEncoding(String encoding)

Set the encoding to be used to read the stream. The default encoding is UTF-8.

isWriteXMLDeclaration

public boolean isWriteXMLDeclaration()

Get whether to include an XML declaration on the stream to be written.

Returns:

true if the declaration will be written, false otherwise.

setWriteXMLDeclaration

public void setWriteXMLDeclaration(boolean writeXMLDeclaration)

Set whether to include an XML declaration (e.g. <?xml version="1.0" encoding="..."?>) in the stream to be written. This defaults to true.

Parameters:

writeXMLDeclaration - true if the declaration shall be written