org.red5.io.object
Interface Input

All Known Implementing Classes:
Input, Input, Input

public interface Input

Interface for Input which defines the contract methods which are to be implemented. Input object provides ways to read primitives, complex object and object references from byte buffer.

Author:
The Red5 Project (red5@osflash.org), Luke Hubbard, Codegent Ltd (luke@codegent.com)

Method Summary
 void clearReferences()
          Clears all references
 String getString()
          Read a string without the string type header.
 Object readArray(Deserializer deserializer)
          Read an array.
 Boolean readBoolean()
          Read Boolean value
 ByteArray readByteArray()
          Read ByteArray object.
 Object readCustom()
          Read custom object
 byte readDataType()
          Read type of data
 Date readDate()
          Read date object
 Map<String,Object> readKeyValues(Deserializer deserializer)
          Read key - value pairs.
 Object readMap(Deserializer deserializer)
          Read a map containing key - value pairs.
 Object readNull()
          Read Null data type
 Number readNumber()
          Read Number object
 Object readObject(Deserializer deserializer)
          Read an object.
 Object readReference()
          Read reference to Complex Data Type.
 String readString()
          Read String object
 Document readXML()
          Read XML document
 

Method Detail

readDataType

byte readDataType()
Read type of data

Returns:
Type of data as byte

getString

String getString()
Read a string without the string type header.

Returns:
String

readNull

Object readNull()
Read Null data type

Returns:
Null datatype (AS)

readBoolean

Boolean readBoolean()
Read Boolean value

Returns:
Boolean

readNumber

Number readNumber()
Read Number object

Returns:
Number

readString

String readString()
Read String object

Returns:
String

readDate

Date readDate()
Read date object

Returns:
Date

readArray

Object readArray(Deserializer deserializer)
Read an array. This can result in a List or Map being deserialized depending on the array type found.

Returns:
array

readMap

Object readMap(Deserializer deserializer)
Read a map containing key - value pairs. This can result in a List or Map being deserialized depending on the map type found.

Returns:
Map

readObject

Object readObject(Deserializer deserializer)
Read an object.

Returns:
object

readXML

Document readXML()
Read XML document

Returns:
XML DOM document

readCustom

Object readCustom()
Read custom object

Returns:
Custom object

readByteArray

ByteArray readByteArray()
Read ByteArray object.

Returns:
ByteArray object

readReference

Object readReference()
Read reference to Complex Data Type. Objects that are collaborators (properties) of other objects must be stored as references in map of id-reference pairs.


clearReferences

void clearReferences()
Clears all references


readKeyValues

Map<String,Object> readKeyValues(Deserializer deserializer)
Read key - value pairs. This is required for the RecordSet deserializer.



Copyright © 2006-2007 the Red5 project.