Packagehessian.io
Classpublic class HessianOutput
InheritanceHessianOutput Inheritance hessian.io.AbstractHessianOutput

A writer for the Hessian 1.0 protocol. A Hessian 2.0 compatible reader must be able to read the output of this implementation.


Public Methods
 MethodDefined by
  
HessianOutput(out:IDataOutput = null)
Creates a new HessianOutput.
HessianOutput
  
addRef(object:Object):Boolean
Adds an object to the reference list.
HessianOutput
  
completeCall():void
Completes the method call.
HessianOutput
  
completeReply():void
Completes reading the reply.
HessianOutput
  
init(out:IDataOutput):void
Initialize the Hessian stream with the underlying IDataOutput.
HessianOutput
  
printCharArray(value:Array, offset:int, length:int):void
Prints a character array to the stream, encoded as UTF-8.
HessianOutput
  
printLenString(value:String):void
Prints a string to the stream, encoded as UTF-8 with preceeding length.
HessianOutput
  
printString(value:String, offset:int = 0, length:int = -1):void
Prints a string to the stream, encoded as UTF-8.
HessianOutput
  
removeRef(obj:Object):Boolean
Removes a reference.
HessianOutput
  
replaceRef(oldRef:Object, newRef:Object):Boolean
Replaces a reference from one object to another.
HessianOutput
  
resetReferences():void
Resets the references for streaming.
HessianOutput
  
startCall(method:String = null):void
Starts the method call.
HessianOutput
  
startReply():void
Starts the reply.
HessianOutput
  
writeBoolean(value:Boolean):void
Writes a boolean value to the stream.
HessianOutput
  
writeByteBufferEnd(buffer:ByteArray, offset:int, length:int):void
Writes the last chunk of a byte buffer to the stream.
HessianOutput
  
writeByteBufferPart(buffer:ByteArray, offset:int, length:int):void
Writes a byte buffer to the stream.
HessianOutput
  
writeByteBufferStart():void
Writes a byte buffer to the stream.
HessianOutput
  
writeBytes(buffer:ByteArray, offset:int = 0, length:int = -1):void
Writes a byte array to the stream.
HessianOutput
  
writeDouble(value:Number):void
Writes a double value to the stream.
HessianOutput
  
writeFault(code:String, message:String, detail:Object):void
Writes a fault.
HessianOutput
  
writeHeader(name:String):void
Writes a header name.
HessianOutput
  
writeInt(value:int):void
Writes an integer value to the stream.
HessianOutput
  
writeListBegin(length:int, type:String = null):Boolean
Writes the list header to the stream.
HessianOutput
  
writeListEnd():void
Writes the tail of the list to the stream.
HessianOutput
  
writeLong(value:Number):void
Writes a long value to the stream.
HessianOutput
  
writeMapBegin(type:String):void
Writes the map header to the stream.
HessianOutput
  
writeMapEnd():void
Writes the tail of the map to the stream.
HessianOutput
  
writeMethod(method:String):void
Writes the method tag.
HessianOutput
  
writeNull():void
Writes a null value to the stream.
HessianOutput
  
writeObject(object:Object, className:String = null):void
Writes a generic object to the output stream.
HessianOutput
  
writeRef(value:int):void
Writes a reference.
HessianOutput
  
writeString(value:*, offset:int = 0, length:int = 0):void
Writes a string value to the stream using UTF-8 encoding.
HessianOutput
  
writeUTCDate(time:Number):void
Writes a date to the stream.
HessianOutput
Constructor detail
HessianOutput()constructor
public function HessianOutput(out:IDataOutput = null)

Creates a new HessianOutput.

Parameters
out:IDataOutput (default = null) — The IDataOutput to which this HessianOutput will write.

See also

init(IDataOutput)
Method detail
addRef()method
public override function addRef(object:Object):Boolean

Adds an object to the reference list. If the object already exists, writes the reference, otherwise, the caller is responsible for the serialization. 

       R b32 b24 b16 b8

Parameters
object:Object — The object to add as a reference.

Returns
Boolean — true if the object has already been written.
completeCall()method 
public override function completeCall():void

Completes the method call. 

       z

completeReply()method 
public override function completeReply():void

Completes reading the reply.

A successful completion will have a single value: 

       z

init()method 
public override function init(out:IDataOutput):void

Initialize the Hessian stream with the underlying IDataOutput. This method will reset the internal data of this instance, meaning this HessianOutput may be reused.

Parameters
out:IDataOutput — The IDataOutput to which this HessianOutput will write.
printCharArray()method 
public function printCharArray(value:Array, offset:int, length:int):void

Prints a character array to the stream, encoded as UTF-8.

Parameters
value:Array — The character array value to write.
 
offset:int — The offset in the string of where to start.
 
length:int — The length in the string to write.
printLenString()method 
public function printLenString(value:String):void

Prints a string to the stream, encoded as UTF-8 with preceeding length.

Parameters
value:String — The string value to write.
printString()method 
public function printString(value:String, offset:int = 0, length:int = -1):void

Prints a string to the stream, encoded as UTF-8.

Parameters
value:String — The string value to write.
 
offset:int (default = 0) — The offset in the string of where to start.
 
length:int (default = -1) — The length in the string to write.
removeRef()method 
public override function removeRef(obj:Object):Boolean

Removes a reference.

Parameters
obj:Object — The object which has a reference.

Returns
Boolean — true if a reference was present for the given object.
replaceRef()method 
public override function replaceRef(oldRef:Object, newRef:Object):Boolean

Replaces a reference from one object to another.

Parameters
oldRef:Object — The object which has a reference to replace.
 
newRef:Object — The object to which to assign the reference.

Returns
Boolean — true if a reference was present for the given object.
resetReferences()method 
public override function resetReferences():void

Resets the references for streaming.

startCall()method 
public override function startCall(method:String = null):void

Starts the method call. 

       c major minor
       m b16 b8 method-namek

Parameters
method:String (default = null) — The method name to call.
startReply()method 
public override function startReply():void

Starts the reply.

A successful completion will have a single value: 

       r

writeBoolean()method 
public override function writeBoolean(value:Boolean):void

Writes a boolean value to the stream. The boolean will be written with the following syntax: 

       T
       F

Parameters
value:Boolean — The boolean value to write.
writeByteBufferEnd()method 
public override function writeByteBufferEnd(buffer:ByteArray, offset:int, length:int):void

Writes the last chunk of a byte buffer to the stream. 

       b b16 b18 bytes

Parameters
buffer:ByteArray — The byte buffer value to write.
 
offset:int — The offset in the array of where to start.
 
length:int — The length in the array to write.
writeByteBufferPart()method 
public override function writeByteBufferPart(buffer:ByteArray, offset:int, length:int):void

Writes a byte buffer to the stream. 

       b b16 b18 bytes

Parameters
buffer:ByteArray — The byte buffer value to write.
 
offset:int — The offset in the array of where to start.
 
length:int — The length in the array to write.
writeByteBufferStart()method 
public override function writeByteBufferStart():void

Writes a byte buffer to the stream.

writeBytes()method 
public override function writeBytes(buffer:ByteArray, offset:int = 0, length:int = -1):void

Writes a byte array to the stream. The array will be written with the following syntax: 

       B b16 b18 bytes

If the value is null, it will be written as 

       N

Parameters
buffer:ByteArray — The byte buffer value to write.
 
offset:int (default = 0) — The offset in the array of where to start.
 
length:int (default = -1) — The length in the array to write.
writeDouble()method 
public override function writeDouble(value:Number):void

Writes a double value to the stream. The double will be written with the following syntax: 

       D b64 b56 b48 b40 b32 b24 b16 b8

Parameters
value:Number — The double value to write.
writeFault()method 
public override function writeFault(code:String, message:String, detail:Object):void

Writes a fault.

The fault will be written as a descriptive string followed by an object: 

       f
       <string>code
       <string>the fault code
            <string>message
       <string>the fault mesage
            <string>detail
       mt\x00\xnnjavax.ejb.FinderException
           ...
       z
       z

Parameters
code:String — The fault code, a three digit number.
 
message:String — The fault message.
 
detail:Object — The fault detail.
writeHeader()method 
public override function writeHeader(name:String):void

Writes a header name. The header value must immediately follow. 

       H b16 b8 foo value

Parameters
name:String — The header name.
writeInt()method 
public override function writeInt(value:int):void

Writes an integer value to the stream. The integer will be written with the following syntax: 

       I b32 b24 b16 b8

Parameters
value:int — The integer value to write.
writeListBegin()method 
public override function writeListBegin(length:int, type:String = null):Boolean

Writes the list header to the stream. List writers will call writeListBegin followed by the list contents and then call writeListEnd. 

       <list>
         <type>java.util.ArrayList</type>
         <length>3</length>
         <int>1</int>
         <int>2</int>
         <int>3</int>
       </list>

Parameters
length:int — The length of the list.
 
type:String (default = null) — The type of the elements in the list.

Returns
Boolean — If this list will have an end.
writeListEnd()method 
public override function writeListEnd():void

Writes the tail of the list to the stream.

writeLong()method 
public override function writeLong(value:Number):void

Writes a long value to the stream. The long will be written with the following syntax: 

       L b64 b56 b48 b40 b32 b24 b16 b8

Parameters
value:Number — The long value to write.
writeMapBegin()method 
public override function writeMapBegin(type:String):void

Writes the map header to the stream. Map writers will call writeMapBegin followed by the map contents and then call writeMapEnd. 

       Mt b16 b8 type ( )z

Parameters
type:String — The type of the map to write.
writeMapEnd()method 
public override function writeMapEnd():void

Writes the tail of the map to the stream.

writeMethod()method 
public override function writeMethod(method:String):void

Writes the method tag. 

       m b16 b8 method-name

Parameters
method:String — The method name to call.
writeNull()method 
public override function writeNull():void

Writes a null value to the stream. The null will be written with the following syntax 

       N

writeObject()method 
public override function writeObject(object:Object, className:String = null):void

Writes a generic object to the output stream.

Parameters
object:Object — The object to write.
 
className:String (default = null) — The name of the class to write to the stream. May be the name of a primitive or user created class.
writeRef()method 
public override function writeRef(value:int):void

Writes a reference. 

       R b32 b24 b16 b8

Parameters
value:int — The integer value to write.
writeString()method 
public override function writeString(value:*, offset:int = 0, length:int = 0):void

Writes a string value to the stream using UTF-8 encoding. The string will be written with the following syntax: 

       S b16 b8 string-value

If the value is null, it will be written as 

       N

Parameters
value:* — The string value to write.
 
offset:int (default = 0) — The offset in the string of where to start.
 
length:int (default = 0) — The length in the string to write.
writeUTCDate()method 
public override function writeUTCDate(time:Number):void

Writes a date to the stream. 

       T  b64 b56 b48 b40 b32 b24 b16 b8

Parameters
time:Number — The date in milliseconds from the epoch in UTC