raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

Adding some ScalaDoc to the Serializer

Browse source
This commit is contained in:
Viktor Klang 2011-07-19 19:28:17 +02:00
parent bb558c03f4
commit fe1051af30
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
akka-actor/src/main/scala/akka/serialization/Serializer.scala
View file

@ -12,13 +12,24 @@ object Serializer {
type Identifier = Byte type Identifier = Byte
} }
/**
* A Serializer represents a bimap between an object and an array of bytes representing that object
*/
trait Serializer extends scala.Serializable { trait Serializer extends scala.Serializable {
/** /**
* Completely unique Byte value to identify this implementation of Serializer, used to optimize network traffic * Completely unique Byte value to identify this implementation of Serializer, used to optimize network traffic
* Values from 0 to 16 is reserved for Akka internal usage * Values from 0 to 16 is reserved for Akka internal usage
*/ */
def identifier: Serializer.Identifier def identifier: Serializer.Identifier
/**
* Serializes the given object into an Array of Byte
*/
def toBinary(o: AnyRef): Array[Byte] def toBinary(o: AnyRef): Array[Byte]
/**
* Produces an object from an array of bytes, with an optional type-hint and a classloader to load the class into
*/
def fromBinary(bytes: Array[Byte], clazz: Option[Class[_]] = None, classLoader: Option[ClassLoader] = None): AnyRef def fromBinary(bytes: Array[Byte], clazz: Option[Class[_]] = None, classLoader: Option[ClassLoader] = None): AnyRef
} }