org.objectweb.jeremie.libs.presentation.std
Class StdMarshallerFactory.StdMarshaller

java.lang.Object
  |
  +--java.io.OutputStream
        |
        +--org.objectweb.jeremie.libs.presentation.std.StdMarshallerFactory.StdMarshaller

All Implemented Interfaces:

JRMIMarshaller, Marshaller

Direct Known Subclasses:

StdMarshallerFactory.StdMarshallerL

Enclosing class:

StdMarshallerFactory

public abstract class StdMarshallerFactory.StdMarshaller

extends OutputStream

implements JRMIMarshaller

StdMarshaller is an (abstract) implementation of Marshaller.

Field Summary

protected Context	context
protected Chunk	current
protected Chunk	first
protected int	offset
protected org.objectweb.jeremie.libs.presentation.std.StdMarshallerFactory.JRMIOutputStream	os
protected int	top

Constructor Summary

StdMarshallerFactory.StdMarshaller()

Method Summary

void	close() This method causes the message to lose all its references to the underlying chunks, and release each of them.
Context	getContext() Returns a Context associated with this marshaller.
int	getOffset() Returns the current offset in the message, i.e., the position in the message at which the next byte will be written.
Chunk	getState() Returns the state of the message as a (chain of) chunk(s).
OutputStream	outputStream() Returns an output stream to write into the message.
protected void	prepare()
void	reset() This method causes the message to lose all its references to the underlying chunks, without releasing them.
boolean	sameContents(Marshaller other) Checks if the target marshaller and the provided one have the same contents, i.e., they contain the same bits.
void	setOffset(int off) Sets the offset in the message.
void	write(byte[] array, int off, int len) Writes 'len' bytes from the specified byte array starting at offset 'off' to this output message.
void	write(Chunk chunk) Writes a chunk in the message.
void	write(int b) Writes the specified byte to this message.
void	writeBoolean(boolean v) Writes a boolean in a message.
void	writeByte(byte v) Writes a byte in a message.
void	writeByteArray(byte[] array, int off, int len) Writes an array of bytes in a message.
void	writeChar8(char v) Writes a char in a message.
void	writeException(Exception ex) Writes an exception thrown by a remote method invocation to an underlying stream.
void	writeMethod(Method method) Writes the method in a remote method invocation to an underlying stream.
void	writeParameters(Object[] params) Writes the arguments in a remote method invocation to an underlying stream.
void	writeReference(Object value) Method used by stubs when they need to send interfaces references.
void	writeResult(Object result) Writes the result of a remote method invocation to an underlying stream.
void	writeString8(String str) Writes a string in a message.
void	writeValue(Object value) Writes a value in the marshaller.

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.objectweb.jonathan.apis.presentation.Marshaller

isLittleEndian, writeChar16, writeDouble, writeFloat, writeInt, writeLong, writeShort, writeString16

Field Detail

first

protected Chunk first

current

protected Chunk current

offset

protected int offset

top

protected int top

os

protected org.objectweb.jeremie.libs.presentation.std.StdMarshallerFactory.JRMIOutputStream os

context

protected Context context

Constructor Detail

StdMarshallerFactory.StdMarshaller

public StdMarshallerFactory.StdMarshaller()

Method Detail

write

public void write(Chunk chunk)

Description copied from interface: Marshaller

Writes a chunk in the message.

The target becomes the "owner" of the provided chunk, and therefore is not supposed to duplicate it. If the entity invoking this operation wants to keep a reference to the chunk, it must be duplicated.

Specified by:

write in interface Marshaller

Following copied from interface: org.objectweb.jonathan.apis.presentation.Marshaller

Parameters:

chunk - the chunk to be written.

getState

public Chunk getState()

Description copied from interface: Marshaller

Returns the state of the message as a (chain of) chunk(s).

The returned chunk(s) are NOT duplicated. If the caller keeps a reference to them, it must reset the message, and not continue to use it.

Specified by:

getState in interface Marshaller

Following copied from interface: org.objectweb.jonathan.apis.presentation.Marshaller

Returns:

the state of the message as a (chain of) chunk(s).

getOffset

public int getOffset()

Description copied from interface: Marshaller

Returns the current offset in the message, i.e., the position in the message at which the next byte will be written.

Specified by:

getOffset in interface Marshaller

Following copied from interface: org.objectweb.jonathan.apis.presentation.Marshaller

Returns:

the current offset in the message.

setOffset

public void setOffset(int off)

Description copied from interface: Marshaller

Sets the offset in the message.

This method may be used to override data already written into the message.

Specified by:

setOffset in interface Marshaller

Following copied from interface: org.objectweb.jonathan.apis.presentation.Marshaller

Parameters:

offset - the new offset.

reset

public void reset()

Description copied from interface: Marshaller

This method causes the message to lose all its references to the underlying chunks, without releasing them. This method must not be used if no reference to chunks present in the message is held by an entity in charge of their release. It also releases the context associated with the target marshaller.

Specified by:

reset in interface Marshaller

close

public void close()

Description copied from interface: Marshaller

This method causes the message to lose all its references to the underlying chunks, and release each of them. It also released the context.

Specified by:

close in interface Marshaller

Overrides:

close in class OutputStream

outputStream

public OutputStream outputStream()

Description copied from interface: Marshaller

Returns an output stream to write into the message. Closing the output stream has the same effect as closing the marshaller itself.

Specified by:

outputStream in interface Marshaller

Following copied from interface: org.objectweb.jonathan.apis.presentation.Marshaller

Returns:

an output stream to write into the message.

getContext

public final Context getContext()

Description copied from interface: Marshaller

Returns a Context associated with this marshaller.

Specified by:

getContext in interface Marshaller

Following copied from interface: org.objectweb.jonathan.apis.presentation.Marshaller

Returns:

a Context associated with this marshaller.

sameContents

public final boolean sameContents(Marshaller other)

Description copied from interface: Marshaller

Checks if the target marshaller and the provided one have the same contents, i.e., they contain the same bits.

Specified by:

sameContents in interface Marshaller

Following copied from interface: org.objectweb.jonathan.apis.presentation.Marshaller

Parameters:

marshaller - a marshaller;

Returns:

true if the target marshaller and the provided one have the same contents, false otherwise.

writeByte

public void writeByte(byte v)
               throws JonathanException

Writes a byte in a message.

Specified by:

writeByte in interface Marshaller

Parameters:

v - a byte;

Throws:

JonathanException - if an error occurs.

writeBoolean

public void writeBoolean(boolean v)
                  throws JonathanException

Writes a boolean in a message.

Specified by:

writeBoolean in interface Marshaller

Parameters:

v - a boolean;

Throws:

JonathanException - if an error occurs.

writeChar8

public void writeChar8(char v)
                throws JonathanException

Writes a char in a message.

Specified by:

writeChar8 in interface Marshaller

Parameters:

v - a char;

Throws:

JonathanException - if an error occurs.

writeString8

public void writeString8(String str)
                  throws JonathanException

Writes a string in a message.

Specified by:

writeString8 in interface Marshaller

Parameters:

str - a string;

Throws:

JonathanException - if an error occurs.

writeReference

public final void writeReference(Object value)
                          throws JonathanException

Method used by stubs when they need to send interfaces references.

Specified by:

writeReference in interface Marshaller

Parameters:

exp - the surrogate that must be sent;

writeValue

public final void writeValue(Object value)
                      throws JonathanException

Description copied from interface: Marshaller

Writes a value in the marshaller.

Specified by:

writeValue in interface Marshaller

Following copied from interface: org.objectweb.jonathan.apis.presentation.Marshaller

Parameters:

obj - an object

Throws:

JonathanException - if a marshal error occurred.

writeByteArray

public void writeByteArray(byte[] array,
                           int off,
                           int len)
                    throws JonathanException

Writes an array of bytes in a message.

Specified by:

writeByteArray in interface Marshaller

Parameters:

array - an array of bytes;

Throws:

JonathanException - if an error occurs.

write

public final void write(int b)
                 throws IOException

Writes the specified byte to this message.

This method calls the write(byte) method.

Overrides:

write in class OutputStream

Parameters:

b - the byte.

Throws:

IOException - if no buffer to write to could be obtained.

write

public final void write(byte[] array,
                        int off,
                        int len)
                 throws IOException

Writes 'len' bytes from the specified byte array starting at offset 'off' to this output message.

Overrides:

write in class OutputStream

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

writeMethod

public void writeMethod(Method method)
                 throws MarshalException

Description copied from interface: JRMIMarshaller

Writes the method in a remote method invocation to an underlying stream.

Specified by:

writeMethod in interface JRMIMarshaller

Following copied from interface: org.objectweb.jeremie.apis.presentation.JRMIMarshaller

Parameters:

m - the method to be written.

Throws:

MarshalException - if something goes wrong.

writeParameters

public void writeParameters(Object[] params)
                     throws MarshalException

Description copied from interface: JRMIMarshaller

Writes the arguments in a remote method invocation to an underlying stream.

Specified by:

writeParameters in interface JRMIMarshaller

Following copied from interface: org.objectweb.jeremie.apis.presentation.JRMIMarshaller

Parameters:

p - the objects representing the arguments.

Throws:

MarshalException - if something goes wrong.

writeResult

public void writeResult(Object result)
                 throws MarshalException

Description copied from interface: JRMIMarshaller

Writes the result of a remote method invocation to an underlying stream.

Specified by:

writeResult in interface JRMIMarshaller

Following copied from interface: org.objectweb.jeremie.apis.presentation.JRMIMarshaller

Parameters:

o - the object representing the result.

Throws:

MarshalException - if something goes wrong.

writeException

public void writeException(Exception ex)
                    throws MarshalException

Description copied from interface: JRMIMarshaller

Writes an exception thrown by a remote method invocation to an underlying stream.

Specified by:

writeException in interface JRMIMarshaller

Following copied from interface: org.objectweb.jeremie.apis.presentation.JRMIMarshaller

Parameters:

e - the thrown exception.

Throws:

MarshalException - if something goes wrong.

prepare

protected void prepare()
                throws JonathanException