Modifier and Type	Class and Description
private static class	Marshalling.StaticStreamHeader

Modifier and Type	Field and Description
private static final ClassExternalizerFactory	NULL_CLASS_EXTERNALIZER_FACTORY
private static final ClassTable	NULL_CLASS_TABLE
private static final ObjectResolver	NULL_OBJECT_RESOLVER
private static final ObjectTable	NULL_OBJECT_TABLE
private static final StreamHeader	NULL_STREAM_HEADER

Access	Constructor and Description
private	Marshalling()

Method Summary

Modifier and Type	Method and Description
public static ByteInput	Returns: the byte input wrapper createByteInput(final ByteBuffer the byte buffer buffer) Create a `ByteInput` wrapper for a `ByteBuffer`.
public static ByteInput	Returns: the byte input wrapper createByteInput(final InputStream the input stream inputStream) Create a `ByteInput` wrapper for an `InputStream`.
public static ByteOutput	Returns: the byte output wrapper createByteOutput(final ByteBuffer the byte buffer buffer) Create a `ByteOutput` wrapper for a `ByteBuffer`.
public static ByteOutput	Returns: the byte output wrapper createByteOutput(final OutputStream the output stream outputStream) Create a `ByteOutput` wrapper for an `OutputStream`.
public static InputStream	Returns: the input stream wrapper createInputStream(final ByteInput the byte input byteInput) Create an `InputStream` wrapper for a `ByteInput`.
public static OptionalDataException	Returns: a new OptionalDataException createOptionalDataException(boolean `true` if there is no more data in the buffered part of the stream eof) Construct a new `java.io.OptionalDataException`.
public static OptionalDataException	Returns: a new OptionalDataException createOptionalDataException(int the number of bytes of primitive data available to be read in the current buffer length) Construct a new `java.io.OptionalDataException`.
public static OutputStream	Returns: the output stream wrapper createOutputStream(final ByteOutput the byte output byteOutput) Create a `OutputStream` wrapper for a `ByteOutput`.
public static MarshallerFactory	Returns: the marshaller factory, or `null` if no matching factory was found getMarshallerFactory(final String the name of the protocol to acquire name) Deprecated It is recommended that you use `getProvidedMarshallerFactory(String)` instead; using the context class loader to find a marshalling implementation is risky at best as the user may have just about anything on their class path. Get a marshaller factory, by name.
public static MarshallerFactory	Returns: the marshaller factory, or `null` if no matching factory was found getMarshallerFactory(final String the name of the protocol to acquire name, final ClassLoader the class loader to use classLoader) Get a marshaller factory, by name.
public static MarshallerFactory	Returns: the marshaller factory, or `null` if no matching factory was found getProvidedMarshallerFactory(final String the name of the protocol to acquire name) Get a marshaller factory which is visible to this implementation, by name.
private static MarshallerFactory	loadMarshallerFactory(ServiceLoader<ProviderDescriptor> loader, String name)
public static ClassExternalizerFactory	Returns: the null class externalizer factory nullClassExternalizerFactory() Return the null class externalizer factory.
public static ClassTable	Returns: the null class table nullClassTable() Return the null class table instance.
public static ObjectResolver	Returns: the null object resolver nullObjectResolver() Return the null object resolver.
public static ObjectTable	Returns: the null instance table nullObjectTable() Return the null object instance table.
public static StreamHeader	Returns: the default stream header producer nullStreamHeader() Get the default stream header producer, which reads and writes no header at all.
public static void	readFully(ByteInput the input input, byte[] the destination dest) Read bytes from a `ByteInput`.
public static void	readFully(ByteInput the input input, byte[] the destination dest, int the offset into the array offs, int the number of bytes len) Read bytes from a `ByteInput`.
public static StreamHeader	Returns: the stream header object streamHeader(final byte[] the header bytes headerBytes) Create a stream header that uses the given bytes.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

NULL_CLASS_EXTERNALIZER_FACTORY	back to summary
private static final ClassExternalizerFactory NULL_CLASS_EXTERNALIZER_FACTORY

NULL_CLASS_TABLE	back to summary
private static final ClassTable NULL_CLASS_TABLE

NULL_OBJECT_RESOLVER	back to summary
private static final ObjectResolver NULL_OBJECT_RESOLVER

NULL_OBJECT_TABLE	back to summary
private static final ObjectTable NULL_OBJECT_TABLE

NULL_STREAM_HEADER	back to summary
private static final StreamHeader NULL_STREAM_HEADER

Constructor Detail

Marshalling	back to summary
private Marshalling()

Method Detail

createByteInput back to summary

createByteInput	back to summary
public static ByteInput createByteInput(final ByteBuffer buffer) Create a `ByteInput` wrapper for a `ByteBuffer`. Parameters buffer:ByteBuffer the byte buffer Returns:ByteInput the byte input wrapper

public static ByteInput createByteInput(final ByteBuffer buffer)

Create a ByteInput wrapper for a ByteBuffer.

Parameters

buffer:ByteBuffer: the byte buffer

Returns:ByteInput

the byte input wrapper

createByteInput back to summary

createByteInput	back to summary
public static ByteInput createByteInput(final InputStream inputStream) Create a `ByteInput` wrapper for an `InputStream`. Parameters inputStream:InputStream the input stream Returns:ByteInput the byte input wrapper

public static ByteInput createByteInput(final InputStream inputStream)

Create a ByteInput wrapper for an InputStream.

Parameters

inputStream:InputStream: the input stream

Returns:ByteInput

the byte input wrapper

createByteOutput back to summary

createByteOutput	back to summary
public static ByteOutput createByteOutput(final ByteBuffer buffer) Create a `ByteOutput` wrapper for a `ByteBuffer`. Parameters buffer:ByteBuffer the byte buffer Returns:ByteOutput the byte output wrapper

public static ByteOutput createByteOutput(final ByteBuffer buffer)

Create a ByteOutput wrapper for a ByteBuffer.

Parameters

buffer:ByteBuffer: the byte buffer

Returns:ByteOutput

the byte output wrapper

createByteOutput back to summary

createByteOutput	back to summary
public static ByteOutput createByteOutput(final OutputStream outputStream) Create a `ByteOutput` wrapper for an `OutputStream`. Parameters outputStream:OutputStream the output stream Returns:ByteOutput the byte output wrapper

public static ByteOutput createByteOutput(final OutputStream outputStream)

Create a ByteOutput wrapper for an OutputStream.

Parameters

outputStream:OutputStream: the output stream

Returns:ByteOutput

the byte output wrapper

createInputStream back to summary

createInputStream	back to summary
public static InputStream createInputStream(final ByteInput byteInput) Create an `InputStream` wrapper for a `ByteInput`. Parameters byteInput:ByteInput the byte input Returns:InputStream the input stream wrapper

public static InputStream createInputStream(final ByteInput byteInput)

Create an InputStream wrapper for a ByteInput.

Parameters

byteInput:ByteInput: the byte input

Returns:InputStream

the input stream wrapper

createOptionalDataException back to summary

createOptionalDataException	back to summary
public static OptionalDataException createOptionalDataException(boolean eof) Construct a new `java.io.OptionalDataException`. This method is necessary because there are no public constructors in the API. Parameters eof:boolean `true` if there is no more data in the buffered part of the stream Returns:OptionalDataException a new OptionalDataException

public static OptionalDataException createOptionalDataException(boolean eof)

Construct a new java.io.OptionalDataException. This method is necessary because there are no public constructors in the API.

Parameters

eof:boolean: true if there is no more data in the buffered part of the stream

Returns:OptionalDataException

a new OptionalDataException

createOptionalDataException back to summary

createOptionalDataException	back to summary
public static OptionalDataException createOptionalDataException(int length) Construct a new `java.io.OptionalDataException`. This method is necessary because there are no public constructors in the API. Parameters length:int the number of bytes of primitive data available to be read in the current buffer Returns:OptionalDataException a new OptionalDataException

public static OptionalDataException createOptionalDataException(int length)

Construct a new java.io.OptionalDataException. This method is necessary because there are no public constructors in the API.

Parameters

length:int: the number of bytes of primitive data available to be read in the current buffer

Returns:OptionalDataException

a new OptionalDataException

createOutputStream back to summary

createOutputStream	back to summary
public static OutputStream createOutputStream(final ByteOutput byteOutput) Create a `OutputStream` wrapper for a `ByteOutput`. Parameters byteOutput:ByteOutput the byte output Returns:OutputStream the output stream wrapper

public static OutputStream createOutputStream(final ByteOutput byteOutput)

Create a OutputStream wrapper for a ByteOutput.

Parameters

byteOutput:ByteOutput: the byte output

Returns:OutputStream

the output stream wrapper

getMarshallerFactory back to summary

getMarshallerFactory	back to summary
public static MarshallerFactory getMarshallerFactory(final String name) Deprecated It is recommended that you use `getProvidedMarshallerFactory(String)` instead; using the context class loader to find a marshalling implementation is risky at best as the user may have just about anything on their class path. Get a marshaller factory, by name. Uses the thread's current context classloader, if available, to locate the factory. Parameters name:String the name of the protocol to acquire Returns:MarshallerFactory the marshaller factory, or `null` if no matching factory was found Annotations @Deprecated See Also `ServiceLoader`

public static MarshallerFactory getMarshallerFactory(final String name)

Deprecated

It is recommended that you use getProvidedMarshallerFactory(String) instead; using the context class loader to find a marshalling implementation is risky at best as the user may have just about anything on their class path.

Get a marshaller factory, by name. Uses the thread's current context classloader, if available, to locate the factory.

Parameters

name:String: the name of the protocol to acquire

Returns:MarshallerFactory

the marshaller factory, or null if no matching factory was found

Annotations

@Deprecated

See Also

ServiceLoader

getMarshallerFactory back to summary

getMarshallerFactory	back to summary
public static MarshallerFactory getMarshallerFactory(final String name, final ClassLoader classLoader) Get a marshaller factory, by name. Uses the given classloader to locate the factory. Parameters name:String the name of the protocol to acquire classLoader:ClassLoader the class loader to use Returns:MarshallerFactory the marshaller factory, or `null` if no matching factory was found See Also `ServiceLoader`

public static MarshallerFactory getMarshallerFactory(final String name, final ClassLoader classLoader)

Get a marshaller factory, by name. Uses the given classloader to locate the factory.

Parameters

name:String: the name of the protocol to acquire
classLoader:ClassLoader: the class loader to use

Returns:MarshallerFactory

the marshaller factory, or null if no matching factory was found

See Also

ServiceLoader

getProvidedMarshallerFactory back to summary

getProvidedMarshallerFactory	back to summary
public static MarshallerFactory getProvidedMarshallerFactory(final String name) Get a marshaller factory which is visible to this implementation, by name. Uses the class loader of this API. Parameters name:String the name of the protocol to acquire Returns:MarshallerFactory the marshaller factory, or `null` if no matching factory was found

public static MarshallerFactory getProvidedMarshallerFactory(final String name)

Get a marshaller factory which is visible to this implementation, by name. Uses the class loader of this API.

Parameters

name:String: the name of the protocol to acquire

Returns:MarshallerFactory

the marshaller factory, or null if no matching factory was found

loadMarshallerFactory	back to summary
private static MarshallerFactory loadMarshallerFactory(ServiceLoader<ProviderDescriptor> loader, String name)

nullClassExternalizerFactory	back to summary
public static ClassExternalizerFactory nullClassExternalizerFactory() Return the null class externalizer factory. This instance does not externalize any classes. Returns:ClassExternalizerFactory the null class externalizer factory

nullClassExternalizerFactory

back to summary

public static ClassExternalizerFactory nullClassExternalizerFactory()

Return the null class externalizer factory. This instance does not externalize any classes.

Returns:ClassExternalizerFactory: the null class externalizer factory

nullClassTable	back to summary
public static ClassTable nullClassTable() Return the null class table instance. This instance contains no predefined classes. Returns:ClassTable the null class table

nullClassTable

back to summary

public static ClassTable nullClassTable()

Return the null class table instance. This instance contains no predefined classes.

Returns:ClassTable: the null class table

nullObjectResolver	back to summary
public static ObjectResolver nullObjectResolver() Return the null object resolver. This instance does not translate objects in any way. Returns:ObjectResolver the null object resolver

nullObjectResolver

back to summary

public static ObjectResolver nullObjectResolver()

Return the null object resolver. This instance does not translate objects in any way.

Returns:ObjectResolver: the null object resolver

nullObjectTable	back to summary
public static ObjectTable nullObjectTable() Return the null object instance table. This instance contains no predefined instances. Returns:ObjectTable the null instance table

nullObjectTable

back to summary

public static ObjectTable nullObjectTable()

Return the null object instance table. This instance contains no predefined instances.

Returns:ObjectTable: the null instance table

nullStreamHeader	back to summary
public static StreamHeader nullStreamHeader() Get the default stream header producer, which reads and writes no header at all. Returns:StreamHeader the default stream header producer

nullStreamHeader

back to summary

public static StreamHeader nullStreamHeader()

Get the default stream header producer, which reads and writes no header at all.

Returns:StreamHeader: the default stream header producer

readFully back to summary

readFully	back to summary
public static void readFully(ByteInput input, byte[] dest) throws IOException Read bytes from a `ByteInput`. Fully fills in the array. Parameters input:ByteInput the input dest:byte[] the destination Exceptions IOException: if an I/O error occurs EOFException: if the end of file is reached before the array is filled

public static void readFully(ByteInput input, byte[] dest) throws IOException

Read bytes from a ByteInput. Fully fills in the array.

Parameters

input:ByteInput: the input
dest:byte[]: the destination

Exceptions

IOException:: if an I/O error occurs
EOFException:: if the end of file is reached before the array is filled

readFully back to summary

readFully	back to summary
public static void readFully(ByteInput input, byte[] dest, int offs, int len) throws IOException Read bytes from a `ByteInput`. Fully fills in `len` bytes in the array. Parameters input:ByteInput the input dest:byte[] the destination offs:int the offset into the array len:int the number of bytes Exceptions IOException: if an I/O error occurs EOFException: if the end of file is reached before the array is filled

public static void readFully(ByteInput input, byte[] dest, int offs, int len) throws IOException

Read bytes from a ByteInput. Fully fills in len bytes in the array.

Parameters

input:ByteInput: the input
dest:byte[]: the destination
offs:int: the offset into the array
len:int: the number of bytes

Exceptions

IOException:: if an I/O error occurs
EOFException:: if the end of file is reached before the array is filled

streamHeader	back to summary
public static StreamHeader streamHeader(final byte[] headerBytes) Create a stream header that uses the given bytes. Parameters headerBytes:byte[] the header bytes Returns:StreamHeader the stream header object

streamHeader

back to summary

public static StreamHeader streamHeader(final byte[] headerBytes)

Create a stream header that uses the given bytes.

Parameters

headerBytes:byte[]: the header bytes

Returns:StreamHeader

the stream header object

org.jboss.marshalling back to summary

private final Class Marshalling.StaticStreamHeader

Class Inheritance

extends Object
implements StreamHeader, Serializable

java.lang.Object
org.jboss.marshalling.Marshalling.StaticStreamHeader

All Implemented Interfaces

java.io.Serializable, org.jboss.marshalling.StreamHeader

Field Summary

Modifier and Type	Field and Description
private final byte[]	headerBytes
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	StaticStreamHeader(final byte[] bytes)

Method Summary

Modifier and Type	Method and Description
public void	readHeader(final ByteInput the stream header input) Implements org.jboss.marshalling.StreamHeader.readHeader. Read the stream header from the stream.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	writeHeader(final ByteOutput the stream header output) Implements org.jboss.marshalling.StreamHeader.writeHeader. Write the stream header to the stream.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

headerBytes	back to summary
private final byte[] headerBytes

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

StaticStreamHeader	back to summary
public StaticStreamHeader(final byte[] bytes)

Method Detail

readHeader	back to summary
public void readHeader(final ByteInput input) throws IOException Implements org.jboss.marshalling.StreamHeader.readHeader. Doc from org.jboss.marshalling.StreamHeader.readHeader. Read the stream header from the stream. Parameters input:ByteInput the stream header Exceptions IOException: if the header is invalid or an error occurs

readHeader

back to summary

public void readHeader(final ByteInput input) throws IOException

Implements org.jboss.marshalling.StreamHeader.readHeader.

Doc from org.jboss.marshalling.StreamHeader.readHeader.

Read the stream header from the stream.

Parameters

input:ByteInput: the stream header

Exceptions

IOException:: if the header is invalid or an error occurs

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object.

writeHeader	back to summary
public void writeHeader(final ByteOutput output) throws IOException Implements org.jboss.marshalling.StreamHeader.writeHeader. Doc from org.jboss.marshalling.StreamHeader.writeHeader. Write the stream header to the stream. Parameters output:ByteOutput the stream header Exceptions IOException: if an error occurs

writeHeader

back to summary

public void writeHeader(final ByteOutput output) throws IOException

Implements org.jboss.marshalling.StreamHeader.writeHeader.

Doc from org.jboss.marshalling.StreamHeader.writeHeader.

Write the stream header to the stream.

Parameters

output:ByteOutput: the stream header

Exceptions

IOException:: if an error occurs

public final Class Marshalling

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class Marshalling.StaticStreamHeader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail