Package org.apache.ignite.internal.binary

Interface BinaryWriterEx

All Superinterfaces:

AutoCloseable, BinaryRawWriter, BinaryWriter, DataOutput, ObjectOutput

public interface BinaryWriterEx
extends BinaryWriter, BinaryRawWriter, ObjectOutput

Extended writer interface.

Method Summary

Modifier and Type	Method	Description
byte[]	array()
void	close()	Cleans resources.
BinaryContext	context()
BinarySchema	currentSchema()
void	doWriteEnumArray(Object[] val)
boolean	failIfUnregistered()
void	marshal(Object obj)
BinaryWriterEx	newWriter(int typeId)	Create new writer with same context.
BinaryOutputStream	out()
void	popSchema()	Pop schema.
void	postWrite(boolean userType, boolean registered)	Perform post-write.
void	postWriteHashCode(@Nullable String clsName)	Perform post-write hash code update if necessary.
void	preWrite(@Nullable String clsName)	Perform pre-write.
int	reserveInt()	Reserve a room for an integer.
int	schemaId()
void	schemaId(int schemaId)
boolean	tryWriteAsHandle(Object obj)	Attempts to write the object as a handle.
void	write(byte[] b, int off, int len)	Writes a sub array of bytes.
void	writeBinaryArray(org.apache.ignite.internal.binary.BinaryArray val)
void	writeBinaryEnum(BinaryObjectEx val)
void	writeBinaryObject(@Nullable BinaryObjectEx po)
void	writeBooleanFieldPrimitive(boolean val)
int	writeByteArray(InputStream in, int limit)	Write byte array from the InputStream.
void	writeByteFieldPrimitive(byte val)
void	writeCharFieldPrimitive(char val)
void	writeClass(Class val)
void	writeDoubleFieldPrimitive(double val)
void	writeField(Object obj, org.apache.ignite.internal.binary.BinaryFieldDescriptor fld)	Write field.
void	writeFieldId(int fieldId)	Write field ID.
void	writeFloatFieldPrimitive(float val)
void	writeInt(int pos, int val)	Write int value at the specific position.
void	writeIntFieldPrimitive(int val)
void	writeLongFieldPrimitive(long val)
void	writeObjectDetached(@Nullable Object obj)
void	writeProxy(Proxy proxy, Class<?>[] intfs)
void	writeShortFieldPrimitive(short val)

Methods inherited from interface org.apache.ignite.binary.BinaryRawWriter

writeBoolean, writeBooleanArray, writeByte, writeByteArray, writeChar, writeCharArray, writeCollection, writeDate, writeDateArray, writeDecimal, writeDecimalArray, writeDouble, writeDoubleArray, writeEnum, writeEnumArray, writeFloat, writeFloatArray, writeInt, writeIntArray, writeLong, writeLongArray, writeMap, writeObject, writeObjectArray, writeShort, writeShortArray, writeString, writeStringArray, writeTime, writeTimeArray, writeTimestamp, writeTimestampArray, writeUuid, writeUuidArray

Methods inherited from interface org.apache.ignite.binary.BinaryWriter

rawWriter, writeBoolean, writeBooleanArray, writeByte, writeByteArray, writeChar, writeCharArray, writeCollection, writeDate, writeDateArray, writeDecimal, writeDecimalArray, writeDouble, writeDoubleArray, writeEnum, writeEnumArray, writeFloat, writeFloatArray, writeInt, writeIntArray, writeLong, writeLongArray, writeMap, writeObject, writeObjectArray, writeShort, writeShortArray, writeString, writeStringArray, writeTime, writeTimeArray, writeTimestamp, writeTimestampArray, writeUuid, writeUuidArray

Methods inherited from interface java.io.DataOutput

writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeDouble, writeFloat, writeInt, writeLong, writeShort, writeUTF

Methods inherited from interface java.io.ObjectOutput

flush, write, write, writeObject

Method Detail

writeObjectDetached

void writeObjectDetached(@Nullable
                         @Nullable Object obj)
                  throws BinaryObjectException

Parameters:

obj - Object to write.

Throws:

BinaryObjectException - In case of error.

out

BinaryOutputStream out()

Returns:

Output stream.

close

void close()

Cleans resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ObjectOutput

reserveInt

int reserveInt()

Reserve a room for an integer.

Returns:

Position in the stream where value is to be written.

writeInt

void writeInt(int pos,
              int val)
       throws BinaryObjectException

Write int value at the specific position.

Parameters:

pos - Position.

val - Value.

Throws:

BinaryObjectException - If failed.

failIfUnregistered

boolean failIfUnregistered()

Returns:

Fail if unregistered flag value.

marshal

void marshal(Object obj)
      throws BinaryObjectException

Parameters:

obj - Object.

Throws:

BinaryObjectException - In case of error.

array

byte[] array()

Returns:

Array.

preWrite

void preWrite(@Nullable
              @Nullable String clsName)

Perform pre-write. Reserves space for header and writes class name if needed.

Parameters:

clsName - Class name (optional).

postWrite

void postWrite(boolean userType,
               boolean registered)

Perform post-write. Fills object header.

Parameters:

userType - User type flag.

registered - Whether type is registered.

postWriteHashCode

void postWriteHashCode(@Nullable
                       @Nullable String clsName)

Perform post-write hash code update if necessary.

Parameters:

clsName - Class name. Always null if class is registered.

popSchema

void popSchema()

Pop schema.

writeFieldId

void writeFieldId(int fieldId)

Write field ID.

Parameters:

fieldId - Field ID.

newWriter

BinaryWriterEx newWriter(int typeId)

Create new writer with same context.

Parameters:

typeId - type

Returns:

New writer.

write

void write(byte[] b,
           int off,
           int len)

Writes a sub array of bytes.

Specified by:

write in interface DataOutput

Specified by:

write in interface ObjectOutput

Parameters:

b - the data to be written

off - the start offset in the data

len - the number of bytes that are written

schemaId

int schemaId()

Returns:

Schema ID.

schemaId

void schemaId(int schemaId)

Parameters:

schemaId - Schema ID.

context

BinaryContext context()

Returns:

Binary context.

writeBooleanFieldPrimitive

void writeBooleanFieldPrimitive(boolean val)

Parameters:

val - Value.

writeByteFieldPrimitive

void writeByteFieldPrimitive(byte val)

Parameters:

val - Value.

writeCharFieldPrimitive

void writeCharFieldPrimitive(char val)

Parameters:

val - Value.

writeShortFieldPrimitive

void writeShortFieldPrimitive(short val)

Parameters:

val - Value.

writeIntFieldPrimitive

void writeIntFieldPrimitive(int val)

Parameters:

val - Value.

writeLongFieldPrimitive

void writeLongFieldPrimitive(long val)

Parameters:

val - Value.

writeFloatFieldPrimitive

void writeFloatFieldPrimitive(float val)

Parameters:

val - Value.

writeDoubleFieldPrimitive

void writeDoubleFieldPrimitive(double val)

Parameters:

val - Value.

writeByteArray

int writeByteArray(InputStream in,
                   int limit)
            throws BinaryObjectException

Write byte array from the InputStream.

If limit > 0 than no more than limit bytes will be read and written. If limit == -1 than it will try to read and write all bytes.

In any case if actual number of bytes is greater than MAX_ARRAY_SIZE than exception will be thrown.

Parameters:

in - InputStream.

limit - Max length of data to be read from the stream or -1 if all data should be read.

Returns:

Number of bytes written.

Throws:

BinaryObjectException - If an I/O error occurs or stream contains more than MAX_ARRAY_SIZE bytes.

writeBinaryObject

void writeBinaryObject(@Nullable
                       @Nullable BinaryObjectEx po)
                throws BinaryObjectException

Parameters:

po - Binary object.

Throws:

BinaryObjectException - In case of error.

writeField

void writeField(Object obj,
                org.apache.ignite.internal.binary.BinaryFieldDescriptor fld)
         throws BinaryObjectException

Write field.

Parameters:

obj - Object.

fld - Field.

Throws:

BinaryObjectException - If failed.

currentSchema

BinarySchema currentSchema()

Returns:

Current writer's schema.

tryWriteAsHandle

boolean tryWriteAsHandle(Object obj)

Attempts to write the object as a handle.

Parameters:

obj - Object to write.

Returns:

true if the object has been written as a handle.

writeBinaryArray

void writeBinaryArray(org.apache.ignite.internal.binary.BinaryArray val)

Parameters:

val - Array wrapper.

Throws:

BinaryObjectException - In case of error.

doWriteEnumArray

void doWriteEnumArray(Object[] val)

Parameters:

val - Array.

writeBinaryEnum

void writeBinaryEnum(BinaryObjectEx val)

Parameters:

val - Value.

writeClass

void writeClass(Class val)

Parameters:

val - Class.

writeProxy

void writeProxy(Proxy proxy,
                Class<?>[] intfs)

Parameters:

proxy - Proxy.