com.amazon.ion.impl

Class _Private_CurriedValueFactory

java.lang.Object

com.amazon.ion.impl._Private_CurriedValueFactory

All Implemented Interfaces:

ValueFactory

public abstract class _Private_CurriedValueFactory
extends java.lang.Object
implements ValueFactory

NOT FOR APPLICATION USE!

Helper for implementing curried container insertion methods such as IonStruct.put(String).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	_Private_CurriedValueFactory(ValueFactory factory)

Method Summary

Modifier and Type	Method and Description
<T extends IonValue> T	clone(T value) Creates a deep copy of an Ion value.
protected abstract void	handle(IonValue newValue) Subclasses override this to do something with each newly-constructed value.
IonBlob	newBlob(byte[] value) Constructs a new Ion blob instance, copying bytes from an array.
IonBlob	newBlob(byte[] value, int offset, int length) Constructs a new Ion blob, copying bytes from part of an array.
IonBool	newBool(boolean value) Constructs a new bool instance with the given value.
IonBool	newBool(java.lang.Boolean value) Constructs a new bool instance with the given value.
IonClob	newClob(byte[] value) Constructs a new Ion clob instance from a byte array.
IonClob	newClob(byte[] value, int offset, int length) Constructs a new Ion clob, copying bytes from part of an array.
IonDecimal	newDecimal(java.math.BigDecimal value) Constructs a new Ion decimal instance from a Java BigDecimal.
IonDecimal	newDecimal(java.math.BigInteger value) Constructs a new Ion decimal instance from a Java BigInteger.
IonDecimal	newDecimal(double value) Constructs a new Ion decimal instance from a Java double.
IonDecimal	newDecimal(long value) Constructs a new Ion decimal instance from a Java long.
IonList	newEmptyList() Constructs a new empty (not null) list instance.
IonSexp	newEmptySexp() Constructs a new empty (not null) sexp instance.
IonStruct	newEmptyStruct() Constructs a new empty (not null) struct instance.
IonFloat	newFloat(double value) Constructs a new Ion float instance from a Java double.
IonFloat	newFloat(long value) Constructs a new Ion float instance from a Java long.
IonInt	newInt(int value) Constructs a new int instance with the given value.
IonInt	newInt(long value) Constructs a new int instance with the given value.
IonInt	newInt(java.lang.Number value) Constructs a new int instance with the given value.
IonList	newList(java.util.Collection<? extends IonValue> values) Deprecated.
IonList	newList(int[] values) Constructs a new list with given int children.
IonList	newList(IonSequence firstChild) Constructs a new list with the given child.
IonList	newList(IonValue... values) Constructs a new list with the given children.
IonList	newList(long[] values) Constructs a new list with given long child elements.
IonNull	newNull() Constructs a new null.null instance.
IonValue	newNull(IonType type) Constructs a new Ion null value with the given type.
IonBlob	newNullBlob() Constructs a new null.blob instance.
IonBool	newNullBool() Constructs a new null.bool instance.
IonClob	newNullClob() Constructs a new null.clob instance.
IonDecimal	newNullDecimal() Constructs a new null.decimal instance.
IonFloat	newNullFloat() Constructs a new null.float instance.
IonInt	newNullInt() Constructs a new null.int instance.
IonList	newNullList() Constructs a new null.list instance.
IonSexp	newNullSexp() Constructs a new null.sexp instance.
IonString	newNullString() Constructs a new null.string instance.
IonStruct	newNullStruct() Constructs a new null.struct instance.
IonSymbol	newNullSymbol() Constructs a new null.symbol instance.
IonTimestamp	newNullTimestamp() Constructs a new null.timestamp instance.
IonSexp	newSexp(java.util.Collection<? extends IonValue> values) Deprecated.
IonSexp	newSexp(int[] values) Constructs a new sexp with given int child values.
IonSexp	newSexp(IonSequence firstChild) Constructs a new sexp with the given child.
IonSexp	newSexp(IonValue... values) Constructs a new sexp with given child elements.
IonSexp	newSexp(long[] values) Constructs a new sexp with given long child elements.
IonString	newString(java.lang.String value) Constructs a new Ion string with the given value.
IonSymbol	newSymbol(java.lang.String value) Constructs a new Ion symbol with the given value.
IonSymbol	newSymbol(SymbolToken value) Constructs a new Ion symbol with the given symbol token.
IonTimestamp	newTimestamp(Timestamp value) Constructs a new timestamp instance with the given value.

Methods inherited from class java.lang.Object

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

Constructor Detail

_Private_CurriedValueFactory

protected _Private_CurriedValueFactory(ValueFactory factory)

Parameters:

factory - must not be null.

Method Detail

handle

protected abstract void handle(IonValue newValue)

Subclasses override this to do something with each newly-constructed value.

Parameters:

newValue - was just constructed by myFactory.

newNullBlob

public IonBlob newNullBlob()

Description copied from interface: ValueFactory

Constructs a new null.blob instance.

Specified by:

newNullBlob in interface ValueFactory

newBlob

public IonBlob newBlob(byte[] value)

Description copied from interface: ValueFactory

Constructs a new Ion blob instance, copying bytes from an array.

Specified by:

newBlob in interface ValueFactory

Parameters:

value - the data for the new blob, to be copied from the given array into the new instance. May be null to create a null.blob value.

newBlob

public IonBlob newBlob(byte[] value,
                       int offset,
                       int length)

Description copied from interface: ValueFactory

Constructs a new Ion blob, copying bytes from part of an array.

This method copies length bytes from the given array into the new value, starting at the given offset in the array.

Specified by:

newBlob in interface ValueFactory

Parameters:

value - the data for the new blob, to be copied from the given array into the new instance. May be null to create a null.blob value.

offset - the offset within the array of the first byte to copy; must be non-negative and no larger than bytes.length.

length - the number of bytes to be copied from the given array; must be non-negative and no larger than bytes.length - offset.

newNullBool

public IonBool newNullBool()

Description copied from interface: ValueFactory

Constructs a new null.bool instance.

Specified by:

newNullBool in interface ValueFactory

newBool

public IonBool newBool(boolean value)

Description copied from interface: ValueFactory

Constructs a new bool instance with the given value.

Specified by:

newBool in interface ValueFactory

Parameters:

value - the new bool's value.

Returns:

a bool with IonBool.booleanValue() == value.

newBool

public IonBool newBool(java.lang.Boolean value)

Description copied from interface: ValueFactory

Constructs a new bool instance with the given value.

Specified by:

newBool in interface ValueFactory

Parameters:

value - the new bool's value. may be null to make null.bool.

newNullClob

public IonClob newNullClob()

Description copied from interface: ValueFactory

Constructs a new null.clob instance.

Specified by:

newNullClob in interface ValueFactory

newClob

public IonClob newClob(byte[] value)

Description copied from interface: ValueFactory

Constructs a new Ion clob instance from a byte array.

Specified by:

newClob in interface ValueFactory

Parameters:

value - the data for the new clob, to be copied from the given array into the new instance. May be null to create a null.clob value.

newClob

public IonClob newClob(byte[] value,
                       int offset,
                       int length)

Description copied from interface: ValueFactory

Constructs a new Ion clob, copying bytes from part of an array.

This method copies length bytes from the given array into the new value, starting at the given offset in the array.

Specified by:

newClob in interface ValueFactory

Parameters:

value - the data for the new blob, to be copied from the given array into the new instance. May be null to create a null.clob value.

offset - the offset within the array of the first byte to copy; must be non-negative an no larger than bytes.length.

length - the number of bytes to be copied from the given array; must be non-negative an no larger than bytes.length - offset.

newNullDecimal

public IonDecimal newNullDecimal()

Description copied from interface: ValueFactory

Constructs a new null.decimal instance.

Specified by:

newNullDecimal in interface ValueFactory

newDecimal

public IonDecimal newDecimal(long value)

Description copied from interface: ValueFactory

Constructs a new Ion decimal instance from a Java long.

Specified by:

newDecimal in interface ValueFactory

newDecimal

public IonDecimal newDecimal(double value)

Description copied from interface: ValueFactory

Constructs a new Ion decimal instance from a Java double.

Note that this does not generate the exact decimal representation of the double's binary floating-point value as via BigDecimal(double), but instead uses the more predictable behavior of matching the double's string representation as via BigDecimal.valueOf(double).

Specified by:

newDecimal in interface ValueFactory

newDecimal

public IonDecimal newDecimal(java.math.BigInteger value)

Description copied from interface: ValueFactory

Constructs a new Ion decimal instance from a Java BigInteger.

Specified by:

newDecimal in interface ValueFactory

newDecimal

public IonDecimal newDecimal(java.math.BigDecimal value)

Description copied from interface: ValueFactory

Constructs a new Ion decimal instance from a Java BigDecimal. To create negative zero values, pass a Decimal.

Specified by:

newDecimal in interface ValueFactory

newNullFloat

public IonFloat newNullFloat()

Description copied from interface: ValueFactory

Constructs a new null.float instance.

Specified by:

newNullFloat in interface ValueFactory

newFloat

public IonFloat newFloat(long value)

Description copied from interface: ValueFactory

Constructs a new Ion float instance from a Java long.

Specified by:

newFloat in interface ValueFactory

newFloat

public IonFloat newFloat(double value)

Description copied from interface: ValueFactory

Constructs a new Ion float instance from a Java double.

Specified by:

newFloat in interface ValueFactory

newNullInt

public IonInt newNullInt()

Description copied from interface: ValueFactory

Constructs a new null.int instance.

Specified by:

newNullInt in interface ValueFactory

newInt

public IonInt newInt(int value)

Description copied from interface: ValueFactory

Constructs a new int instance with the given value.

Specified by:

newInt in interface ValueFactory

Parameters:

value - the new int's value.

newInt

public IonInt newInt(long value)

Description copied from interface: ValueFactory

Constructs a new int instance with the given value.

Specified by:

newInt in interface ValueFactory

Parameters:

value - the new int's value.

newInt

public IonInt newInt(java.lang.Number value)

Description copied from interface: ValueFactory

Constructs a new int instance with the given value. The integer portion of the number is used, any fractional portion is ignored.

Specified by:

newInt in interface ValueFactory

Parameters:

value - the new int's value; may be null to make null.int.

newNullList

public IonList newNullList()

Description copied from interface: ValueFactory

Constructs a new null.list instance.

Specified by:

newNullList in interface ValueFactory

newEmptyList

public IonList newEmptyList()

Description copied from interface: ValueFactory

Constructs a new empty (not null) list instance.

Specified by:

newEmptyList in interface ValueFactory

newList

@Deprecated
public IonList newList(java.util.Collection<? extends IonValue> values)
                            throws ContainedValueException,
                                   java.lang.NullPointerException

Deprecated.

Description copied from interface: ValueFactory

Constructs a new list with given children.

Specified by:

newList in interface ValueFactory

Parameters:

values - the initial set of children. If null, then the new instance will have IonValue.isNullValue() == true.

Throws:

ContainedValueException - if any value in values has IonValue.getContainer() != null.

java.lang.NullPointerException - if any value in values is null.

newList

public IonList newList(IonSequence firstChild)
                throws ContainedValueException,
                       java.lang.NullPointerException

Description copied from interface: ValueFactory

Constructs a new list with the given child.

This method is temporary until ValueFactory.newList(Collection) is removed. It's sole purpose is to avoid the doomed attempt to add all of the parameter's children to the new list; that will always throw ContainedValueException.

Specified by:

newList in interface ValueFactory

Parameters:

firstChild - the initial child of the new list.

Throws:

ContainedValueException - if child has IonValue.getContainer() != null.

java.lang.NullPointerException - if child is null.

newList

public IonList newList(IonValue... values)
                throws ContainedValueException,
                       java.lang.NullPointerException

Description copied from interface: ValueFactory

Constructs a new list with the given children.

Some edge cases are worth examples:

    factory.newList();                     // returns []
    factory.newList((IonValue[]) null);    // returns null.list

For clarity, applications should prefer ValueFactory.newEmptyList() and ValueFactory.newNullList() instead.

Specified by:

newList in interface ValueFactory

Parameters:

values - the initial sequence of children. If null, then the new instance will have IonValue.isNullValue() == true.

Throws:

ContainedValueException - if any child has IonValue.getContainer() != null.

java.lang.NullPointerException - if any child is null.

newList

public IonList newList(int[] values)

Description copied from interface: ValueFactory

Constructs a new list with given int children.

Specified by:

newList in interface ValueFactory

Parameters:

values - the initial set of child values. If null, then the new instance will have IonValue.isNullValue() == true. Otherwise, the resulting sequence will contain new IonInts with the given values.

Returns:

a new list where each element is an IonInt.

newList

public IonList newList(long[] values)

Description copied from interface: ValueFactory

Constructs a new list with given long child elements.

Specified by:

newList in interface ValueFactory

Parameters:

values - the initial set of child values. If null, then the new instance will have IonValue.isNullValue() == true. Otherwise, the resulting sequence will contain new IonInts with the given values.

Returns:

a new list where each element is an IonInt.

newNull

public IonNull newNull()

Description copied from interface: ValueFactory

Constructs a new null.null instance.

Specified by:

newNull in interface ValueFactory

newNull

public IonValue newNull(IonType type)

Description copied from interface: ValueFactory

Constructs a new Ion null value with the given type.

Specified by:

newNull in interface ValueFactory

Parameters:

type - must not be Java null, but it may be IonType.NULL.

Returns:

a new value such that IonValue.isNullValue() is true.

newNullSexp

public IonSexp newNullSexp()

Description copied from interface: ValueFactory

Constructs a new null.sexp instance.

Specified by:

newNullSexp in interface ValueFactory

newEmptySexp

public IonSexp newEmptySexp()

Description copied from interface: ValueFactory

Constructs a new empty (not null) sexp instance.

Specified by:

newEmptySexp in interface ValueFactory

newSexp

@Deprecated
public IonSexp newSexp(java.util.Collection<? extends IonValue> values)
                            throws ContainedValueException,
                                   java.lang.NullPointerException

Deprecated.

Description copied from interface: ValueFactory

Constructs a new sexp with given child elements.

Specified by:

newSexp in interface ValueFactory

Parameters:

values - the initial set of children. If null, then the new instance will have IonValue.isNullValue() == true.

Throws:

ContainedValueException - if any value in values has IonValue.getContainer() != null.

java.lang.NullPointerException - if any value in values is null.

newSexp

public IonSexp newSexp(IonSequence firstChild)
                throws ContainedValueException,
                       java.lang.NullPointerException

Description copied from interface: ValueFactory

Constructs a new sexp with the given child.

This method is temporary until ValueFactory.newSexp(Collection) is removed. It's sole purpose is to avoid the doomed attempt to add all of the parameter's children to the new sequence; that will always throw ContainedValueException.

Specified by:

newSexp in interface ValueFactory

Parameters:

firstChild - the initial child of the new sexp.

Throws:

ContainedValueException - if child has IonValue.getContainer() != null.

java.lang.NullPointerException - if child is null.

newSexp

public IonSexp newSexp(IonValue... values)
                throws ContainedValueException,
                       java.lang.NullPointerException

Description copied from interface: ValueFactory

Constructs a new sexp with given child elements.

Some edge cases are worth examples:

    factory.newSexp();                     // returns ()
    factory.newSexp((IonValue[]) null);    // returns null.sexp

For clarity, applications should prefer ValueFactory.newEmptySexp() and ValueFactory.newNullSexp() instead.

Specified by:

newSexp in interface ValueFactory

Parameters:

values - the initial set of children. If null, then the new instance will have IonValue.isNullValue() == true.

Throws:

ContainedValueException - if any child has IonValue.getContainer() != null.

java.lang.NullPointerException - if any child is null.

newSexp

public IonSexp newSexp(int[] values)

Description copied from interface: ValueFactory

Constructs a new sexp with given int child values.

Specified by:

newSexp in interface ValueFactory

Parameters:

values - the initial set of child values. If null, then the new instance will have IonValue.isNullValue() == true. Otherwise, the resulting sequence will contain new IonInts with the given values.

Returns:

a new sexp where each element is an IonInt.

newSexp

public IonSexp newSexp(long[] values)

Description copied from interface: ValueFactory

Constructs a new sexp with given long child elements.

Specified by:

newSexp in interface ValueFactory

Parameters:

values - the initial set of child values. If null, then the new instance will have IonValue.isNullValue() == true. Otherwise, the resulting sequence will contain new IonInts with the given values.

Returns:

a new sexp where each element is an IonInt.

newNullString

public IonString newNullString()

Description copied from interface: ValueFactory

Constructs a new null.string instance.

Specified by:

newNullString in interface ValueFactory

newString

public IonString newString(java.lang.String value)

Description copied from interface: ValueFactory

Constructs a new Ion string with the given value.

Specified by:

newString in interface ValueFactory

Parameters:

value - the text of the new string; may be null to make null.string.

newNullStruct

public IonStruct newNullStruct()

Description copied from interface: ValueFactory

Constructs a new null.struct instance.

Specified by:

newNullStruct in interface ValueFactory

newEmptyStruct

public IonStruct newEmptyStruct()

Description copied from interface: ValueFactory

Constructs a new empty (not null) struct instance.

Specified by:

newEmptyStruct in interface ValueFactory

newNullSymbol

public IonSymbol newNullSymbol()

Description copied from interface: ValueFactory

Constructs a new null.symbol instance.

Specified by:

newNullSymbol in interface ValueFactory

newSymbol

public IonSymbol newSymbol(java.lang.String value)

Description copied from interface: ValueFactory

Constructs a new Ion symbol with the given value.

Specified by:

newSymbol in interface ValueFactory

Parameters:

value - the text of the symbol; may be null to make null.symbol.

newSymbol

public IonSymbol newSymbol(SymbolToken value)

Description copied from interface: ValueFactory

Constructs a new Ion symbol with the given symbol token.

This is an "expert method": correct use requires deep understanding of the Ion binary format. You almost certainly don't want to use it.

Specified by:

newSymbol in interface ValueFactory

Parameters:

value - the text and/or SID of the symbol; may be null to make null.symbol.

newNullTimestamp

public IonTimestamp newNullTimestamp()

Description copied from interface: ValueFactory

Constructs a new null.timestamp instance.

Specified by:

newNullTimestamp in interface ValueFactory

newTimestamp

public IonTimestamp newTimestamp(Timestamp value)

Description copied from interface: ValueFactory

Constructs a new timestamp instance with the given value.

Specified by:

newTimestamp in interface ValueFactory

Parameters:

value - may be null to make null.timestamp.

clone

public <T extends IonValue> T clone(T value)
                             throws IonException

Description copied from interface: ValueFactory

Creates a deep copy of an Ion value. This method can properly clone IonDatagrams.

The given value can be in the context of any ValueFactory, and the result will be in the context of this one. This allows you to shift data from one factory instance to another.

Specified by:

clone in interface ValueFactory

Parameters:

value - the value to copy.

Returns:

a deep copy of value, with no container.

Throws:

IonException - if there's a problem creating the clone.

UnknownSymbolException - if any part of this value has unknown text but known Sid for its field name, annotation or symbol.

See Also:

IonValue.clone()