Modifier and Type	Class and Description
private static class	Printer.BasicSymbolTableProvider
public class	Printer.Options
public static class	Printer.PrinterVisitor Deprecated Use `IonValue#writeTo(IonWriter)` instead.

Modifier and Type	Field and Description
protected Printer.Options	myOptions

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

Method Summary

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

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

myOptions	back to summary
protected Printer.Options myOptions

Constructor Detail

Printer	back to summary
public Printer()

Printer	back to summary
public Printer(Printer.Options options)

Method Detail

_print	back to summary
private void _print(IonValue value, Printer.PrinterVisitor pv) throws IOException References Deprecated `Printer.PrinterVisitor` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

getPrintBlobAsString	back to summary
public synchronized boolean getPrintBlobAsString() Indicates whether this printer renders blobs as Base64 strings. By default, this is `false`.

getPrintClobAsString	back to summary
public synchronized boolean getPrintClobAsString() Indicates whether this printer renders clobs as ASCII strings. By default, this is `false`.

getPrintDatagramAsList	back to summary
public synchronized boolean getPrintDatagramAsList() Indicates whether this printer renders datagrams as lists. By default, this property is `false`.

getPrintDecimalAsFloat	back to summary
public synchronized boolean getPrintDecimalAsFloat() Indicates whether this printer renders decimals as floats, thus using 'e' notation for all real values. By default, this is `false`.

getPrintSexpAsList	back to summary
public synchronized boolean getPrintSexpAsList() Indicates whether this printer renders sexps as lists. By default, this is `false`.

getPrintStringAsJson	back to summary
public synchronized boolean getPrintStringAsJson() Indicates whether this printer renders strings using JSON escapes. By default, this is `false`.

getPrintSymbolAsString	back to summary
public synchronized boolean getPrintSymbolAsString() Indicates whether this printer renders symbols as strings. By default, this is `false`.

getPrintTimestampAsMillis	back to summary
public synchronized boolean getPrintTimestampAsMillis() Indicates whether this printer renders timestamps as millisecond values. By default, this is `false`.

getPrintTimestampAsString	back to summary
public synchronized boolean getPrintTimestampAsString() Indicates whether this printer renders timestamps as strings. By default, this is `false`.

getPrintUntypedNulls	back to summary
public synchronized boolean getPrintUntypedNulls() Indicates whether this printer renders all null values as `null` (i.e., the same as an `IonNull`). By default, this is `false`.

getSkipAnnotations	back to summary
public synchronized boolean getSkipAnnotations() Indicates whether this printer skips (i.e., doesn't print) annotations. By default, this property is `false`.

getSkipSystemValues	back to summary
public synchronized boolean getSkipSystemValues() Indicates whether this printer skips (i.e., doesn't print) system IDs and local symbol tables. By default, this property is `false`.

makeVisitor back to summary

makeVisitor	back to summary
protected Printer.PrinterVisitor makeVisitor(Printer.Options options, Appendable out) References Deprecated `Printer.PrinterVisitor` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Subclasses can override this if they wish to construct a specialization of the `PrinterVisitor`. Parameters options:Printer.Options is a fresh copy of the Printer's options instance, not `null`. out:Appendable is not `null`. Returns:Printer.PrinterVisitor the visitor to invoke for printing.

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

References Deprecated

Printer.PrinterVisitor is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

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

Parameters

options:Printer.Options: is a fresh copy of the Printer's options instance, not null.
out:Appendable: is not null.

Returns:Printer.PrinterVisitor

the visitor to invoke for printing.

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

setJsonMode back to summary

setJsonMode	back to summary
public synchronized void setJsonMode() Configures this printer's options to render legal JSON text. The following options are modified so that: `Options#blobAsString` is `true` `Options#clobAsString` is `true` `Options#datagramAsList` is `true` `Options#decimalAsFloat` is `true` `Options#sexpAsList` is `true` `Options#skipAnnotations` is `true` `Options#skipSystemValues` is `true` `Options#stringAsJson` is `true` `Options#symbolAsString` is `true` `Options#timestampAsString` is `false` `Options#timestampAsMillis` is `true` `Options#untypedNulls` is `true` All other options are left as is.

public synchronized void setJsonMode()

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

All other options are left as is.

setPrintBlobAsString	back to summary
public synchronized void setPrintBlobAsString(boolean blobAsString) Sets whether this printer renders blobs as Base64 strings. By default, this is `false`.

setPrintClobAsString	back to summary
public synchronized void setPrintClobAsString(boolean clobAsString) Sets whether this printer renders clobs as ASCII strings. By default, this is `false`.

setPrintDatagramAsList	back to summary
public synchronized void setPrintDatagramAsList(boolean datagramAsList) Sets whether this printer renders datagrams as lists. By default, this property is `false`.

setPrintDecimalAsFloat	back to summary
public synchronized 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`.

setPrintSexpAsList	back to summary
public synchronized void setPrintSexpAsList(boolean sexpAsList) Sets whether this printer renders sexps as lists. By default, this is `false`.

setPrintStringAsJson	back to summary
public synchronized void setPrintStringAsJson(boolean stringAsJson) Sets whether this printer renders strings using JSON escapes. By default, this is `false`.

setPrintSymbolAsString	back to summary
public synchronized void setPrintSymbolAsString(boolean symbolAsString) Sets whether this printer renders symbols as strings. By default, this is `false`.

setPrintTimestampAsMillis	back to summary
public synchronized void setPrintTimestampAsMillis(boolean timestampAsMillis) Sets whether this printer renders timestamps as millisecond values. By default, this is `false`.

setPrintTimestampAsString	back to summary
public synchronized void setPrintTimestampAsString(boolean timestampAsString) Sets whether this printer renders timestamps as strings. By default, this is `false`.

setPrintUntypedNulls	back to summary
public synchronized 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`.

setSkipAnnotations	back to summary
public synchronized void setSkipAnnotations(boolean skip) Sets whether this printer skips (i.e., doesn't print) annotations. By default, this property is `false`.

setSkipSystemValues	back to summary
public synchronized 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`.

com.amazon.ion.util back to summary

private Class Printer.BasicSymbolTableProvider

Class Inheritance

extends Object
implements SymbolTableProvider

java.lang.Object
com.amazon.ion.util.Printer.BasicSymbolTableProvider

All Implemented Interfaces

com.amazon.ion.impl._Private_IonValue.SymbolTableProvider

Field Summary

Modifier and Type	Field and Description
private final SymbolTable	symbolTable

Constructor Summary

Access	Constructor and Description
public	BasicSymbolTableProvider(SymbolTable symbolTable)

Method Summary

Modifier and Type	Method and Description
public SymbolTable	getSymbolTable() Implements com.amazon.ion.impl._Private_IonValue.SymbolTableProvider.getSymbolTable.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

symbolTable	back to summary
private final SymbolTable symbolTable

Constructor Detail

BasicSymbolTableProvider	back to summary
public BasicSymbolTableProvider(SymbolTable symbolTable)

Method Detail

getSymbolTable	back to summary
public SymbolTable getSymbolTable() Implements com.amazon.ion.impl._Private_IonValue.SymbolTableProvider.getSymbolTable.

com.amazon.ion.util back to summary

public Class Printer.Options

Class Inheritance

extends Object
implements Cloneable

java.lang.Object
com.amazon.ion.util.Printer.Options

All Implemented Interfaces

java.lang.Cloneable

Field Summary

Modifier and Type	Field and Description
public boolean	blobAsString
public boolean	clobAsString
public boolean	datagramAsList
public boolean	decimalAsFloat
public boolean	sexpAsList
public boolean	simplifySystemValues
public boolean	skipAnnotations
public boolean	skipSystemValues
public boolean	stringAsJson
public boolean	symbolAsString
public boolean	timestampAsMillis
public boolean	timestampAsString
public boolean	untypedNulls

Constructor Summary

Access	Constructor and Description
public	Options()

Method Summary

Modifier and Type	Method and Description
public Printer.Options	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

blobAsString	back to summary
public boolean blobAsString

clobAsString	back to summary
public boolean clobAsString

datagramAsList	back to summary
public boolean datagramAsList

decimalAsFloat	back to summary
public boolean decimalAsFloat

sexpAsList	back to summary
public boolean sexpAsList

simplifySystemValues	back to summary
public boolean simplifySystemValues

skipAnnotations	back to summary
public boolean skipAnnotations

skipSystemValues	back to summary
public boolean skipSystemValues

stringAsJson	back to summary
public boolean stringAsJson

symbolAsString	back to summary
public boolean symbolAsString

timestampAsMillis	back to summary
public boolean timestampAsMillis

timestampAsString	back to summary
public boolean timestampAsString

untypedNulls	back to summary
public boolean untypedNulls

Constructor Detail

Options	back to summary
public Options()

Method Detail

clone back to summary

public Printer.Options clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Printer.Options

a clone of this instance.

Annotations

@Override

com.amazon.ion.util back to summary

public Class Printer.PrinterVisitor

Class Inheritance

extends AbstractValueVisitor

java.lang.Object
com.amazon.ion.util.AbstractValueVisitor
com.amazon.ion.util.Printer.PrinterVisitor

Deprecated

Use IonValue#writeTo(IonWriter) instead.

Field Summary

Modifier and Type	Field and Description
protected final Printer.Options	myOptions
protected final Appendable	myOut
private boolean	myQuoteOperators Should we quote operators at the current level of the hierarchy?
private _Private_IonValue.SymbolTableProvider	mySymbolTableProvider

Constructor Summary

Access	Constructor and Description
public	PrinterVisitor(Printer.Options options, Appendable out)

Method Summary

Modifier and Type	Method and Description
protected void	defaultVisit(IonValue the value to visit. value) Overrides com.amazon.ion.util.AbstractValueVisitor.defaultVisit. Default visitation behavior, called by all `visit` methods in `AbstractValueVisitor`.
pack-priv void	setSymbolTableProvider(_Private_IonValue.SymbolTableProvider symbolTableProvider)
private final IonValue	simplify(IonValue child, SymbolTable previous_symbols)
private static final boolean	symbol_table_struct_has_imports(IonValue child)
public void	visit(IonBlob value) Overrides com.amazon.ion.util.AbstractValueVisitor.visit. Implements com.amazon.ion.ValueVisitor.visit.
public void	visit(IonBool value) Overrides com.amazon.ion.util.AbstractValueVisitor.visit. Implements com.amazon.ion.ValueVisitor.visit.
public void	visit(IonClob value) Overrides com.amazon.ion.util.AbstractValueVisitor.visit. Implements com.amazon.ion.ValueVisitor.visit.
public void	visit(IonDatagram value) Overrides com.amazon.ion.util.AbstractValueVisitor.visit. Implements com.amazon.ion.ValueVisitor.visit.
public void	visit(IonDecimal value) Overrides com.amazon.ion.util.AbstractValueVisitor.visit. Implements com.amazon.ion.ValueVisitor.visit.
public void	visit(IonFloat value) Overrides com.amazon.ion.util.AbstractValueVisitor.visit. Implements com.amazon.ion.ValueVisitor.visit.
public void	visit(IonInt value) Overrides com.amazon.ion.util.AbstractValueVisitor.visit. Implements com.amazon.ion.ValueVisitor.visit.
public void	visit(IonList value) Overrides com.amazon.ion.util.AbstractValueVisitor.visit. Implements com.amazon.ion.ValueVisitor.visit.
public void	visit(IonNull value) Overrides com.amazon.ion.util.AbstractValueVisitor.visit. Implements com.amazon.ion.ValueVisitor.visit.
public void	visit(IonSexp value) Overrides com.amazon.ion.util.AbstractValueVisitor.visit. Implements com.amazon.ion.ValueVisitor.visit.
public void	visit(IonString value) Overrides com.amazon.ion.util.AbstractValueVisitor.visit. Implements com.amazon.ion.ValueVisitor.visit.
public void	visit(IonStruct value) Overrides com.amazon.ion.util.AbstractValueVisitor.visit. Implements com.amazon.ion.ValueVisitor.visit.
public void	visit(IonSymbol value) Overrides com.amazon.ion.util.AbstractValueVisitor.visit. Implements com.amazon.ion.ValueVisitor.visit.
public void	visit(IonTimestamp value) Overrides com.amazon.ion.util.AbstractValueVisitor.visit. Implements com.amazon.ion.ValueVisitor.visit.
public void	writeAnnotations(IonValue value)
protected void	writeChild(IonValue value, boolean replaces the current value of `myQuoteOperators` during the recursive visitation. quoteOperators) Recurse down into a container, we push the current value of `myQuoteOperators` onto the stack and replace it with the given value.
public void	writeNull(String type)
public void	writeSequenceContent(IonSequence value, boolean quoteOperators, char open, char separator, char close)
public void	writeString(String may be null text)
public void	writeSymbol(String text)
public void	writeSymbolToken(SymbolToken sym)

Field Detail

myOptions	back to summary
protected final Printer.Options myOptions

myOut	back to summary
protected final Appendable myOut

myQuoteOperators	back to summary
private boolean myQuoteOperators Should we quote operators at the current level of the hierarchy? As we recurse down into containers, this value is pushed on the stack by `writeChild(IonValue, boolean)`.

mySymbolTableProvider	back to summary
private _Private_IonValue.SymbolTableProvider mySymbolTableProvider

Constructor Detail

PrinterVisitor	back to summary
public PrinterVisitor(Printer.Options options, Appendable out)

Method Detail

defaultVisit back to summary

protected void defaultVisit(IonValue value)

Overrides com.amazon.ion.util.AbstractValueVisitor.defaultVisit.

Doc from com.amazon.ion.util.AbstractValueVisitor.defaultVisit.

Default visitation behavior, called by all visit methods in AbstractValueVisitor. Subclasses should override this unless they override all visit methods.

This implementation always throws UnsupportedOperationException.

Parameters

value:IonValue: the value to visit.

Annotations

@Override

setSymbolTableProvider	back to summary
pack-priv void setSymbolTableProvider(_Private_IonValue.SymbolTableProvider symbolTableProvider)

simplify	back to summary
private final IonValue simplify(IonValue child, SymbolTable previous_symbols)

symbol_table_struct_has_imports	back to summary
private static final boolean symbol_table_struct_has_imports(IonValue child)

visit

back to summary

public void visit(IonBlob value) throws IOException

Overrides com.amazon.ion.util.AbstractValueVisitor.visit.

Implements com.amazon.ion.ValueVisitor.visit.

Annotations

@Override

visit

back to summary

public void visit(IonBool value) throws IOException

Overrides com.amazon.ion.util.AbstractValueVisitor.visit.

Implements com.amazon.ion.ValueVisitor.visit.

Annotations

@Override

visit

back to summary

public void visit(IonClob value) throws IOException

Overrides com.amazon.ion.util.AbstractValueVisitor.visit.

Implements com.amazon.ion.ValueVisitor.visit.

Annotations

@Override

visit

back to summary

public void visit(IonDatagram value) throws IOException, Exception

Overrides com.amazon.ion.util.AbstractValueVisitor.visit.

Implements com.amazon.ion.ValueVisitor.visit.

Annotations

@Override

visit

back to summary

public void visit(IonDecimal value) throws IOException

Overrides com.amazon.ion.util.AbstractValueVisitor.visit.

Implements com.amazon.ion.ValueVisitor.visit.

Annotations

@Override

visit

back to summary

public void visit(IonFloat value) throws IOException

Overrides com.amazon.ion.util.AbstractValueVisitor.visit.

Implements com.amazon.ion.ValueVisitor.visit.

Annotations

@Override

visit

back to summary

public void visit(IonInt value) throws IOException

Overrides com.amazon.ion.util.AbstractValueVisitor.visit.

Implements com.amazon.ion.ValueVisitor.visit.

Annotations

@Override

visit

back to summary

public void visit(IonList value) throws IOException, Exception

Overrides com.amazon.ion.util.AbstractValueVisitor.visit.

Implements com.amazon.ion.ValueVisitor.visit.

Annotations

@Override

visit

back to summary

public void visit(IonNull value) throws IOException

Overrides com.amazon.ion.util.AbstractValueVisitor.visit.

Implements com.amazon.ion.ValueVisitor.visit.

Annotations

@Override

visit

back to summary

public void visit(IonSexp value) throws IOException, Exception

Overrides com.amazon.ion.util.AbstractValueVisitor.visit.

Implements com.amazon.ion.ValueVisitor.visit.

Annotations

@Override

visit

back to summary

public void visit(IonString value) throws IOException

Overrides com.amazon.ion.util.AbstractValueVisitor.visit.

Implements com.amazon.ion.ValueVisitor.visit.

Annotations

@Override

visit

back to summary

public void visit(IonStruct value) throws IOException, Exception

Overrides com.amazon.ion.util.AbstractValueVisitor.visit.

Implements com.amazon.ion.ValueVisitor.visit.

Annotations

@Override

visit

back to summary

public void visit(IonSymbol value) throws IOException

Overrides com.amazon.ion.util.AbstractValueVisitor.visit.

Implements com.amazon.ion.ValueVisitor.visit.

Annotations

@Override

visit

back to summary

public void visit(IonTimestamp value) throws IOException

Overrides com.amazon.ion.util.AbstractValueVisitor.visit.

Implements com.amazon.ion.ValueVisitor.visit.

Annotations

@Override

writeAnnotations	back to summary
public void writeAnnotations(IonValue value) throws IOException

writeChild back to summary

protected void writeChild(IonValue value, boolean quoteOperators) throws Exception

Recurse down into a container, we push the current value of myQuoteOperators onto the stack and replace it with the given value.

Parameters

quoteOperators:boolean: replaces the current value of myQuoteOperators during the recursive visitation.

Exceptions

Exception:: propagated from visitation of value.
NullPointerException:: if value is null.

writeNull	back to summary
public void writeNull(String type) throws IOException

writeSequenceContent	back to summary
public void writeSequenceContent(IonSequence value, boolean quoteOperators, char open, char separator, char close) throws IOException, Exception

writeString	back to summary
public void writeString(String text) throws IOException Parameters text:String may be null

writeSymbol	back to summary
public void writeSymbol(String text) throws IOException

writeSymbolToken	back to summary
public void writeSymbolToken(SymbolToken sym) throws IOException

public Class Printer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Printer.BasicSymbolTableProvider

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Printer.Options

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Printer.PrinterVisitor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail