Package jadex.binary
Interface IDecodingContext
-
- All Superinterfaces:
IUserContextContainer
- All Known Implementing Classes:
AbstractDecodingContext
,DataInputDecodingContext
,FramingStreamDecodingContext
,StreamDecodingContext
public interface IDecodingContext extends IUserContextContainer
Decoding context interface.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description long
createObjectId(java.lang.Object object)
Creates ID for an object.java.lang.ClassLoader
getClassloader()
Gets the classloader.java.lang.String
getCurrentClassName()
Gets the current class name.int
getCurrentOffset()
Returns the current offset of the decoding process for debugging.java.util.List<IDecoderHandler>
getDecoderHandlers()
Returns the handlers used to decode objects.IErrorReporter
getErrorReporter()
Gets the error reporter.java.lang.Object
getLastObject()
Returns the last object decoded.java.lang.Object
getObjectForId(long id)
Gets a known object by ID.java.lang.Long
getObjectId(java.lang.Object object)
Gets the ID of a known object.java.util.List<ITraverseProcessor>
getPostProcessors()
Returns the handlers used for post-processing.byte[]
read(byte[] array)
Reads a number of bytes from the buffer and fills the array.boolean
readBoolean()
Reads a boolean value from the buffer.byte
readByte()
Reads a byte from the buffer.java.lang.String
readClassname()
Helper method for decoding a class name.long
readSignedVarInt()
Helper method for decoding a signed variable-sized integer (VarInt).java.lang.String
readString()
Helper method for decoding a string.long
readVarInt()
Helper method for decoding a variable-sized integer (VarInt).void
setLastObject(java.lang.Object lastobject)
Sets the last object decoded.void
setObjectForId(long id, java.lang.Object object)
Sets a known object by ID.void
setVersion(int version)
Sets the format version.void
startObjectFrame(boolean fixedsize)
Starts an object frame when using a context with framing support.void
stopObjectFrame()
Stops an object frame when using a context with framing support.-
Methods inherited from interface jadex.commons.transformation.traverser.IUserContextContainer
getUserContext
-
-
-
-
Method Detail
-
getCurrentClassName
java.lang.String getCurrentClassName()
Gets the current class name.- Returns:
- The current class name.
-
getLastObject
java.lang.Object getLastObject()
Returns the last object decoded.- Returns:
- The last object decoded.
-
setLastObject
void setLastObject(java.lang.Object lastobject)
Sets the last object decoded.- Parameters:
lastobject
- The last object decoded.
-
setVersion
void setVersion(int version)
Sets the format version.- Parameters:
version
- The version.
-
createObjectId
long createObjectId(java.lang.Object object)
Creates ID for an object.- Parameters:
object
- The object- Returns:
- The ID.
-
getObjectForId
java.lang.Object getObjectForId(long id)
Gets a known object by ID.- Parameters:
id
- The ID.- Returns:
- The object or null.
-
setObjectForId
void setObjectForId(long id, java.lang.Object object)
Sets a known object by ID.- Parameters:
id
- The ID.object
- The object..
-
getObjectId
java.lang.Long getObjectId(java.lang.Object object)
Gets the ID of a known object.- Parameters:
object
- The object- Returns:
- The ID.
-
getClassloader
java.lang.ClassLoader getClassloader()
Gets the classloader.- Returns:
- The classloader.
-
getDecoderHandlers
java.util.List<IDecoderHandler> getDecoderHandlers()
Returns the handlers used to decode objects.- Returns:
- The handlers.
-
getErrorReporter
IErrorReporter getErrorReporter()
Gets the error reporter.- Returns:
- The error reporter.
-
getPostProcessors
java.util.List<ITraverseProcessor> getPostProcessors()
Returns the handlers used for post-processing.- Returns:
- Post-processing handlers.
-
readByte
byte readByte()
Reads a byte from the buffer.- Returns:
- A byte.
-
read
byte[] read(byte[] array)
Reads a number of bytes from the buffer and fills the array.- Parameters:
array
- The byte array.- Returns:
- The byte array for convenience.
-
readBoolean
boolean readBoolean()
Reads a boolean value from the buffer.- Returns:
- Boolean value.
-
readString
java.lang.String readString()
Helper method for decoding a string.- Returns:
- String encoded at the current position.
-
readVarInt
long readVarInt()
Helper method for decoding a variable-sized integer (VarInt).- Returns:
- The decoded value.
-
readSignedVarInt
long readSignedVarInt()
Helper method for decoding a signed variable-sized integer (VarInt).- Returns:
- The decoded value.
-
readClassname
java.lang.String readClassname()
Helper method for decoding a class name.- Returns:
- String encoded at the current position.
-
getCurrentOffset
int getCurrentOffset()
Returns the current offset of the decoding process for debugging.- Returns:
- Current offset.
-
startObjectFrame
void startObjectFrame(boolean fixedsize)
Starts an object frame when using a context with framing support.- Parameters:
fixedsize
- If true, use fixed-size (integer) framing. Set true if the object being framed is expected to be larger than 127 bytes (same type of object MUST use either fixed OR variable framing).
-
stopObjectFrame
void stopObjectFrame()
Stops an object frame when using a context with framing support.
-
-