Package com.biomatters.geneious.publicapi.documents.sequence

Class GeneiousObjectInputStream

java.lang.Object

java.io.InputStream

java.io.ObjectInputStream

com.biomatters.geneious.publicapi.documents.sequence.GeneiousObjectInputStream

All Implemented Interfaces:

java.io.Closeable, java.io.DataInput, java.io.ObjectInput, java.io.ObjectStreamConstants, java.lang.AutoCloseable

public class GeneiousObjectInputStream
extends java.io.ObjectInputStream

An input stream to read from data previously written using a GeneiousObjectOutputStream.

Since:

API 4.11 (Geneious 5.0)

Nested Class Summary

Nested classes/interfaces inherited from class java.io.ObjectInputStream

java.io.ObjectInputStream.GetField

Field Summary

Fields inherited from interface java.io.ObjectStreamConstants

baseWireHandle, PROTOCOL_VERSION_1, PROTOCOL_VERSION_2, SC_BLOCK_DATA, SC_ENUM, SC_EXTERNALIZABLE, SC_SERIALIZABLE, SC_WRITE_METHOD, SERIAL_FILTER_PERMISSION, STREAM_MAGIC, STREAM_VERSION, SUBCLASS_IMPLEMENTATION_PERMISSION, SUBSTITUTION_PERMISSION, TC_ARRAY, TC_BASE, TC_BLOCKDATA, TC_BLOCKDATALONG, TC_CLASS, TC_CLASSDESC, TC_ENDBLOCKDATA, TC_ENUM, TC_EXCEPTION, TC_LONGSTRING, TC_MAX, TC_NULL, TC_OBJECT, TC_PROXYCLASSDESC, TC_REFERENCE, TC_RESET, TC_STRING

Constructor Summary

Constructors

Constructor	Description
GeneiousObjectInputStream(java.io.InputStream in)	Constructs a new input stream to read from data previously written using a GeneiousObjectOutputStream.

Method Summary

Modifier and Type	Method	Description
static GeneiousObjectInputStream	newInstance(java.io.InputStream in)	Equivalent to the GeneiousObjectInputStream(InputStream) construction, except that if data corruption is detected in the stream header, the exception message is converted to a more use friendly message with suggestions on what they should do.
byte[]	readByteArray()	Reads an array from this stream that was written using GeneiousObjectOutputStream.writeByteArray(byte[]).
int[]	readIntArray()	Reads an array from this stream that was written using GeneiousObjectOutputStream.writeIntArray(int[]).
SequenceDocument	readSequence()	Reads a sequence from this input stream that was previously written using GeneiousObjectOutputStream.writeSequence(SequenceDocument, jebl.util.ProgressListener)
java.lang.String	readUTF()

Methods inherited from class java.io.ObjectInputStream

available, close, defaultReadObject, enableResolveObject, getObjectInputFilter, read, read, readBoolean, readByte, readChar, readClassDescriptor, readDouble, readFields, readFloat, readFully, readFully, readInt, readLine, readLong, readObject, readObjectOverride, readShort, readStreamHeader, readUnshared, readUnsignedByte, readUnsignedShort, registerValidation, resolveClass, resolveObject, resolveProxyClass, setObjectInputFilter, skipBytes

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, transferTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.ObjectInput

read, skip

Constructor Detail

GeneiousObjectInputStream

public GeneiousObjectInputStream(java.io.InputStream in)
                          throws java.io.IOException

Constructs a new input stream to read from data previously written using a GeneiousObjectOutputStream.

Rather than using this constructor, it is recommended you use newInstance(java.io.InputStream) instead.

Parameters:

in - the stream to read from.

Throws:

java.io.IOException - if an IO error is encountered reading from the input stream

See Also:

newInstance(InputStream)

Method Detail

newInstance

public static GeneiousObjectInputStream newInstance(java.io.InputStream in)
                                             throws java.io.IOException

Equivalent to the GeneiousObjectInputStream(InputStream) construction, except that if data corruption is detected in the stream header, the exception message is converted to a more use friendly message with suggestions on what they should do.

Parameters:

in - the stream to read from.

Returns:

a newly constructed GeneiousObjectInputStream.

Throws:

java.io.IOException - if an IO error is encountered reading from the input stream

Since:

API 4.202120 (Geneious 2021.2.0)

readUTF

public java.lang.String readUTF()
                         throws java.io.IOException

Specified by:

readUTF in interface java.io.DataInput

Overrides:

readUTF in class java.io.ObjectInputStream

Throws:

java.io.IOException

readIntArray

public int[] readIntArray()
                   throws java.io.IOException

Reads an array from this stream that was written using GeneiousObjectOutputStream.writeIntArray(int[]).

Returns:

the array read back in, which may be null.

Throws:

java.io.IOException - if an IO error is encountered reading from the input stream

See Also:

GeneiousObjectOutputStream.writeIntArray(int[])

readByteArray

public byte[] readByteArray()
                     throws java.io.IOException

Reads an array from this stream that was written using GeneiousObjectOutputStream.writeByteArray(byte[]).

Returns:

the array read back in, which may be null.

Throws:

java.io.IOException - if an IO error is encountered reading from the input stream

See Also:

GeneiousObjectOutputStream.writeByteArray(byte[])

readSequence

public SequenceDocument readSequence()
                              throws java.io.IOException

Reads a sequence from this input stream that was previously written using GeneiousObjectOutputStream.writeSequence(SequenceDocument, jebl.util.ProgressListener)

Returns:

the sequence read

Throws:

java.io.IOException - if we can't read a sequence

See Also:

GeneiousObjectOutputStream.writeSequence(SequenceDocument, jebl.util.ProgressListener)