software.amazon.ion.util

Class Printer

java.lang.Object

software.amazon.ion.util.Printer

public class Printer
extends Object

Renders IonValues to text.

By default, output is in a compact format with minimal whitespace. For example:

    annot::{f1:["hello","goodbye"],'another field':long::0}

The format can be tuned through various properties on the Printer instance, as well as through the Printer.Options structure.

Instances of this class are safe for use by multiple threads.

While printers are inexpensive to create, their configuration facilities make them useful as shared resources. Changes to configuration settings (e.g., setJsonMode()) do not affect concurrently-running calls to print(software.amazon.ion.IonValue, java.lang.Appendable).

See Also:

IonWriter, IonTextWriterBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Printer.Options
static class	Printer.PrinterVisitor

Field Summary

Fields

Modifier and Type	Field and Description
protected Printer.Options	myOptions

Constructor Summary

Constructors

Constructor and Description
Printer()
Printer(Printer.Options options)

Method Summary

Modifier and Type	Method and Description
boolean	getPrintBlobAsString() Indicates whether this printer renders blobs as Base64 strings.
boolean	getPrintClobAsString() Indicates whether this printer renders clobs as ASCII strings.
boolean	getPrintDatagramAsList() Indicates whether this printer renders datagrams as lists.
boolean	getPrintDecimalAsFloat() Indicates whether this printer renders decimals as floats, thus using 'e' notation for all real values.
boolean	getPrintSexpAsList() Indicates whether this printer renders sexps as lists.
boolean	getPrintStringAsJson() Indicates whether this printer renders strings using JSON escapes.
boolean	getPrintSymbolAsString() Indicates whether this printer renders symbols as strings.
boolean	getPrintTimestampAsMillis() Indicates whether this printer renders timestamps as millisecond values.
boolean	getPrintTimestampAsString() Indicates whether this printer renders timestamps as strings.
boolean	getPrintUntypedNulls() Indicates whether this printer renders all null values as null (i.e., the same as an IonNull).
boolean	getSkipAnnotations() Indicates whether this printer skips (i.e., doesn't print) annotations.
boolean	getSkipSystemValues() Indicates whether this printer skips (i.e., doesn't print) system IDs and local symbol tables.
protected Printer.PrinterVisitor	makeVisitor(Printer.Options options, Appendable out) Subclasses can override this if they wish to construct a specialization of the Printer.PrinterVisitor.
void	print(IonValue value, Appendable out)
void	setJsonMode() Configures this printer's options to render legal JSON text.
void	setPrintBlobAsString(boolean blobAsString) Sets whether this printer renders blobs as Base64 strings.
void	setPrintClobAsString(boolean clobAsString) Sets whether this printer renders clobs as ASCII strings.
void	setPrintDatagramAsList(boolean datagramAsList) Sets whether this printer renders datagrams as lists.
void	setPrintDecimalAsFloat(boolean decimalAsFloat) Sets whether this printer renders decimals as floats, thus using 'e' notation for all real values.
void	setPrintSexpAsList(boolean sexpAsList) Sets whether this printer renders sexps as lists.
void	setPrintStringAsJson(boolean stringAsJson) Sets whether this printer renders strings using JSON escapes.
void	setPrintSymbolAsString(boolean symbolAsString) Sets whether this printer renders symbols as strings.
void	setPrintTimestampAsMillis(boolean timestampAsMillis) Sets whether this printer renders timestamps as millisecond values.
void	setPrintTimestampAsString(boolean timestampAsString) Sets whether this printer renders timestamps as strings.
void	setPrintUntypedNulls(boolean untypedNulls) Sets whether this printer renders all null values as null (i.e., the same as an IonNull).
void	setSkipAnnotations(boolean skip) Sets whether this printer skips (i.e., doesn't print) annotations.
void	setSkipSystemValues(boolean skip) Sets whether this printer skips (i.e., doesn't print) system IDs and local symbol tables.

Methods inherited from class java.lang.Object

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

Field Detail

myOptions

protected Printer.Options myOptions

Constructor Detail

Printer

public Printer()

Printer

public Printer(Printer.Options options)

Method Detail

getSkipSystemValues

public boolean getSkipSystemValues()

Indicates whether this printer skips (i.e., doesn't print) system IDs and local symbol tables. By default, this property is false.

setSkipSystemValues

public void setSkipSystemValues(boolean skip)

Sets whether this printer skips (i.e., doesn't print) system IDs and local symbol tables. By default, this property is false.

getSkipAnnotations

public boolean getSkipAnnotations()

Indicates whether this printer skips (i.e., doesn't print) annotations. By default, this property is false.

setSkipAnnotations

public void setSkipAnnotations(boolean skip)

Sets whether this printer skips (i.e., doesn't print) annotations. By default, this property is false.

getPrintBlobAsString

public boolean getPrintBlobAsString()

Indicates whether this printer renders blobs as Base64 strings. By default, this is false.

setPrintBlobAsString

public void setPrintBlobAsString(boolean blobAsString)

Sets whether this printer renders blobs as Base64 strings. By default, this is false.

getPrintClobAsString

public boolean getPrintClobAsString()

Indicates whether this printer renders clobs as ASCII strings. By default, this is false.

setPrintClobAsString

public void setPrintClobAsString(boolean clobAsString)

Sets whether this printer renders clobs as ASCII strings. By default, this is false.

getPrintDatagramAsList

public boolean getPrintDatagramAsList()

Indicates whether this printer renders datagrams as lists. By default, this property is false.

setPrintDatagramAsList

public void setPrintDatagramAsList(boolean datagramAsList)

Sets whether this printer renders datagrams as lists. By default, this property is false.

getPrintDecimalAsFloat

public boolean getPrintDecimalAsFloat()

Indicates whether this printer renders decimals as floats, thus using 'e' notation for all real values. By default, this is false.

setPrintDecimalAsFloat

public void setPrintDecimalAsFloat(boolean decimalAsFloat)

Sets whether this printer renders decimals as floats, thus using 'e' notation for all real values. By default, this is false.

getPrintSexpAsList

public boolean getPrintSexpAsList()

Indicates whether this printer renders sexps as lists. By default, this is false.

setPrintSexpAsList

public void setPrintSexpAsList(boolean sexpAsList)

Sets whether this printer renders sexps as lists. By default, this is false.

getPrintStringAsJson

public boolean getPrintStringAsJson()

Indicates whether this printer renders strings using JSON escapes. By default, this is false.

setPrintStringAsJson

public void setPrintStringAsJson(boolean stringAsJson)

Sets whether this printer renders strings using JSON escapes. By default, this is false.

getPrintSymbolAsString

public boolean getPrintSymbolAsString()

Indicates whether this printer renders symbols as strings. By default, this is false.

setPrintSymbolAsString

public void setPrintSymbolAsString(boolean symbolAsString)

Sets whether this printer renders symbols as strings. By default, this is false.

getPrintTimestampAsMillis

public boolean getPrintTimestampAsMillis()

Indicates whether this printer renders timestamps as millisecond values. By default, this is false.

setPrintTimestampAsMillis

public void setPrintTimestampAsMillis(boolean timestampAsMillis)

Sets whether this printer renders timestamps as millisecond values. By default, this is false.

getPrintTimestampAsString

public boolean getPrintTimestampAsString()

Indicates whether this printer renders timestamps as strings. By default, this is false.

setPrintTimestampAsString

public void setPrintTimestampAsString(boolean timestampAsString)

Sets whether this printer renders timestamps as strings. By default, this is false.

getPrintUntypedNulls

public boolean getPrintUntypedNulls()

Indicates whether this printer renders all null values as null (i.e., the same as an IonNull). By default, this is false.

setPrintUntypedNulls

public void setPrintUntypedNulls(boolean untypedNulls)

Sets whether this printer renders all null values as null (i.e., the same as an IonNull). By default, this is false.

setJsonMode

public void setJsonMode()

Configures this printer's options to render legal JSON text. The following options are modified so that:

• Printer.Options.blobAsString is true
• Printer.Options.clobAsString is true
• Printer.Options.datagramAsList is true
• Printer.Options.decimalAsFloat is true
• Printer.Options.sexpAsList is true
• Printer.Options.skipAnnotations is true
• Printer.Options.skipSystemValues is true
• Printer.Options.stringAsJson is true
• Printer.Options.symbolAsString is true
• Printer.Options.timestampAsString is false
• Printer.Options.timestampAsMillis is true
• Printer.Options.untypedNulls is true

All other options are left as is.

print

public void print(IonValue value,
                  Appendable out)
           throws IOException

Throws:

IOException

makeVisitor

protected Printer.PrinterVisitor makeVisitor(Printer.Options options,
                                             Appendable out)

Subclasses can override this if they wish to construct a specialization of the Printer.PrinterVisitor.

Parameters:

options - is a fresh copy of the Printer's options instance, not null.

out - is not null.

Returns:

the visitor to invoke for printing.