com.amazon.ionhash

Interface IonHashReader

All Superinterfaces:

AutoCloseable, Closeable, com.amazon.ion.facet.Faceted, com.amazon.ion.IonReader

public interface IonHashReader
extends com.amazon.ion.IonReader

IonReader extension that provides the hash of the IonValue just nexted past or stepped out of, as defined by the Amazon Ion Hash Specification.

Implementations of this interface are not thread-safe.

See Also:

IonReader

Method Summary

Modifier and Type	Method and Description
byte[]	digest() Provides the hash of the IonValue just nexted past or stepped out of; hashes of partial Ion values are not provided.

Methods inherited from interface com.amazon.ion.IonReader

bigDecimalValue, bigIntegerValue, booleanValue, byteSize, dateValue, decimalValue, doubleValue, getBytes, getDepth, getFieldId, getFieldName, getFieldNameSymbol, getIntegerSize, getSymbolTable, getType, getTypeAnnotations, getTypeAnnotationSymbols, hasNext, intValue, isInStruct, isNullValue, iterateTypeAnnotations, longValue, newBytes, next, stepIn, stepOut, stringValue, symbolValue, timestampValue

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface com.amazon.ion.facet.Faceted

asFacet

Method Detail

digest

byte[] digest()

Provides the hash of the IonValue just nexted past or stepped out of; hashes of partial Ion values are not provided. If there is no current hash value, returns an empty array.

Implementations must calculate the hash independently of how the Ion is traversed (e.g., the hash of a container must be identical whether the caller skips over it, steps into it, or any combination thereof).

Returns:

array of bytes representing the hash of the IonValue just nexted past; if there is no hash, returns an empty array