Marshalled (dxlib 3.346)

java.lang.Object
- com.devexperts.io.Marshalled<T>

Type Parameters:

T - the type of the marshalled object.
```
public final class Marshalled<T>
extends Object
```
Lazily encapsulates object and its byte array representation. The object representation is available via getObject() method and byte array representation via getBytes() method. Conversions from byte array to object and from object to byte array are performed lazily and results of conversions are cached. The strategy the defines how the object is represented in a byte array is specified by Marshaller. There is a built-in serialization marshaller that uses Java Object Serialization. It is used by default. See Marshaller class for more details.

null object is always represented by null byte array and vice versa.

Marshalled object is not serializable by itself, but IOUtil.objectToBytes(Object) and IOUtil.writeObject(DataOutput, Object) methods understand this object and use the result of getBytes() invocation when serialization marshaller is used.

Class loaders

Object representation is resolved on the first invocation of getObject() or getObject(ClassLoader) methods, unless it was explicitly specified during marshalled object creation via forObject(Object) or forObject(Object, Marshaller) methods. The first invocation of getObject defines what class loader is used. If object cannot be deserialized from the corresponding byte array on the first getObject invocation, then all subsequent invocations of any getObject method will throw the same MarshallingException.

Threads and locks

This class is thread-safe. Conversion operations to and from byte array are synchronized internally to ensure that there is at most one conversion operation in progress at any time.

Field Summary

Fields
Modifier and Type Field and Description

static Marshalled<Object> NULL
The null object for default SERIALIZATION marshaller.

Fields
Modifier and Type	Field and Description
`static Marshalled<Object>`	`NULL` The null object for default `SERIALIZATION` marshaller.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`ensureBytes()` Ensures that object is converted into byte representation.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`static Marshalled<Object>`	`forBytes(byte[] bytes)` Returns marshalled object for a specified byte array assuming that The result of this method is not `null`.
`static <T> Marshalled<T>`	`forBytes(byte[] bytes, Marshaller<T> marshaller)` Returns marshalled object for a specified byte array and marshaller.
`static <T> Marshalled<T>`	`forBytes(byte[] bytes, Marshaller<T> marshaller, SerialClassContext serialContext)` Returns marshalled object for a specified byte array and marshaller.
`static <T> Marshalled<T>`	`forObject(T object)` Wraps object into marshalled with a `serialization` marshaller.
`static <T> Marshalled<T>`	`forObject(T object, Marshaller<T> marshaller)` Wraps object into marshalled with a specified marshaller.
`byte[]`	`getBytes()` Returns byte array representation of this marshalled object.
`Marshaller<T>`	`getMarshaller()` Returns a strategy that defines how an object is represented in a byte array.
`T`	`getObject()` Returns object representation of this marshalled object.
`T`	`getObject(ClassLoader cl)` Deprecated. use `getObject()`
`int`	`hashCode()` Returns a hash code value for the object that is composed of the hashcode of its `marshaller` and `bytes`.
`String`	`toString()` Returns a compact string representation of the `object` represented by this marshalled object.
`static Object`	`unwrap(Object object)` Unwraps `Marshalled` argument via `getObject()` call or returns object unmodified.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NULL
```
public static final Marshalled<Object> NULL
```
    The null object for default SERIALIZATION marshaller. This object the the result of forObject(null) invocation and of the forBytes(null) invocation. Both getObject and getBytes methods on this instance return null.
- Method Detail
  - unwrap
```
public static Object unwrap(Object object)
```
    Unwraps Marshalled argument via getObject() call or returns object unmodified.
  - forObject
```
public static <T> Marshalled<T> forObject(T object)
```
    Wraps object into marshalled with a serialization marshaller. The result of this method is not null. It returns NULL object when the argument is null.
    
    Type Parameters:
    
    T - the type of the object.
    
    Parameters:
    
    object - the object.
    
    Returns:
    
    marshalled object.
  - forObject
```
public static <T> Marshalled<T> forObject(T object,
                                          Marshaller<T> marshaller)
```
    Wraps object into marshalled with a specified marshaller. The result of this method is not null.
    
    Type Parameters:
    
    T - the type of the object.
    
    Parameters:
    
    object - the object.
    
    marshaller - the marshaller.
    
    Returns:
    
    marshalled object.
    
    Throws:
    
    NullPointerException - if marshaller does not support null object and object is null.
  - forBytes
```
public static Marshalled<Object> forBytes(byte[] bytes)
```
    Returns marshalled object for a specified byte array assuming that The result of this method is not null. It returns NULL object when the argument is null.
    serialization marshaller was used to create the specified byte array.
    
    Parameters:
    
    bytes - the byte array.
    
    Returns:
    
    marshalled object.
  - forBytes
```
public static <T> Marshalled<T> forBytes(byte[] bytes,
                                         Marshaller<T> marshaller)
```
    Returns marshalled object for a specified byte array and marshaller. The result of this method is not null.
    
    Parameters:
    
    bytes - the byte array.
    
    Returns:
    
    marshalled object.
  - forBytes
```
public static <T> Marshalled<T> forBytes(byte[] bytes,
                                         Marshaller<T> marshaller,
                                         SerialClassContext serialContext)
```
    Returns marshalled object for a specified byte array and marshaller. The result of this method is not null.
    
    Parameters:
    
    bytes - the byte array.
    
    serialContext - the serial class context for load class.
    
    Returns:
    
    marshalled object.
  - getObject
```
public T getObject()
```
    Returns object representation of this marshalled object. This methods loads classes using a context class loader (see Thread.getContextClassLoader) or using the same class loader that loaded classes for this com.devexperts.io package when context class loader is not defined. This is a shortcut for getObject(null).
    
    Returns:
    
    object representation of this marshalled object.
    
    Throws:
    
    MarshallingException - if object cannot be deserialized from its byte array
  - getObject
```
public T getObject(ClassLoader cl)
```
    Deprecated. use getObject()
    
    Returns object representation of this marshalled object with a specified class loader.
    
    Parameters:
    
    cl - the ClassLoader that will be used to load classes; null for context class loader.
    
    Returns:
    
    object representation of this marshalled object with a specified class loader.
    
    Throws:
    
    MarshallingException - if object cannot be deserialized from its byte array
  - ensureBytes
```
public void ensureBytes()
```
    Ensures that object is converted into byte representation.
    
    Throws:
    
    MarshallingException - if object cannot be converted to byte representation
  - getBytes
```
public byte[] getBytes()
```
    Returns byte array representation of this marshalled object.
    
    Returns:
    
    byte array representation of this marshalled object.
  - getMarshaller
```
public Marshaller<T> getMarshaller()
```
    Returns a strategy that defines how an object is represented in a byte array.
    
    Returns:
    
    a strategy that defines how an object is represented in a byte array.
  - equals
```
public boolean equals(Object obj)
```
    Indicates whether some other object is "equal to" this one. Two marshalled objects are equal when their marshallers and bytes are equal.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this object is the same as the obj argument; false otherwise.
    
    Throws:
    
    MarshallingException - if object cannot be serialized to byte array
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for the object that is composed of the hashcode of its marshaller and bytes.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object.
    
    Throws:
    
    MarshallingException - if object cannot be serialized to byte array
  - toString
```
public String toString()
```
    Returns a compact string representation of the object represented by this marshalled object. This method is designed to be used in logs. If object cannot be deserialized from its byte array or there is an exception in its toString method, then it returns error message.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.
    
    See Also:
    
    LogUtil.deepToString(Object)

Class Marshalled<T>

Class loaders

Threads and locks

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL

Method Detail

unwrap

forObject

forObject

forBytes

forBytes

forBytes

getObject

getObject

ensureBytes

getBytes

getMarshaller

equals

hashCode

toString