com.facebook.buck.rules.modern

Class Serializer

java.lang.Object

com.facebook.buck.rules.modern.Serializer

public class Serializer
extends Object

Implementation of Serialization of Buildables.

This works by walking all referenced values with a ValueVisitor.

Referenced "dynamic" objects (i.e. implementations of AddsToRuleKey) are serialized as simply a hash of their serialized representation. The serialization of a complex object is then effectively a merkle tree. This allows us to share the serialized representation of shared objects (for c++ particularly, there are many shared references to the PreprocessorDelegate and other such fields).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Serializer.Delegate The first time a "dynamic" object is encountered (including Buildables themselves), registerNewValue will be called.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TARGET_CONFIGURATION_TYPE_CONFIGURATION
static int	TARGET_CONFIGURATION_TYPE_DEFAULT
static int	TARGET_CONFIGURATION_TYPE_EMPTY

Constructor Summary

Constructors

Constructor and Description
Serializer(SourcePathRuleFinder ruleFinder, CellPathResolver cellResolver, Serializer.Delegate delegate)

Method Summary

Modifier and Type	Method and Description
<T extends AddsToRuleKey> byte[]	reserialize(T instance) Returns the serialized bytes of the instance.
<T extends AddsToRuleKey> com.google.common.hash.HashCode	serialize(T instance) Serializes an object.
<T extends AddsToRuleKey> Either<com.google.common.hash.HashCode,byte[]>	serialize(T instance, ClassInfo<T> classInfo) See Serialize(T instance) above.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TARGET_CONFIGURATION_TYPE_EMPTY

public static final int TARGET_CONFIGURATION_TYPE_EMPTY

See Also:

Constant Field Values

TARGET_CONFIGURATION_TYPE_DEFAULT

public static final int TARGET_CONFIGURATION_TYPE_DEFAULT

See Also:

Constant Field Values

TARGET_CONFIGURATION_TYPE_CONFIGURATION

public static final int TARGET_CONFIGURATION_TYPE_CONFIGURATION

See Also:

Constant Field Values

Constructor Detail

Serializer

public Serializer(SourcePathRuleFinder ruleFinder,
                  CellPathResolver cellResolver,
                  Serializer.Delegate delegate)

Method Detail

serialize

public <T extends AddsToRuleKey> com.google.common.hash.HashCode serialize(T instance)
                                                                    throws IOException

Serializes an object. For small objects, the full serialized format will be returned as a byte[]. For larger objects, the representation will be recorded with the delegate and the hash will be returned.

Throws:

IOException

serialize

public <T extends AddsToRuleKey> Either<com.google.common.hash.HashCode,byte[]> serialize(T instance,
                                                                                          ClassInfo<T> classInfo)
                                                                                   throws IOException

See Serialize(T instance) above.

Throws:

IOException

reserialize

public <T extends AddsToRuleKey> byte[] reserialize(T instance)
                                             throws IOException

Returns the serialized bytes of the instance. This is useful if the caller has lost the value recorded in a previous serialize call.

Throws:

IOException