org.apache.reef.tang.implementation.protobuf

Class ProtocolBufferClassHierarchy

java.lang.Object

org.apache.reef.tang.implementation.protobuf.ProtocolBufferClassHierarchy

All Implemented Interfaces:

ClassHierarchy

public class ProtocolBufferClassHierarchy
extends Object
implements ClassHierarchy

Constructor Summary

Constructors

Constructor and Description
ProtocolBufferClassHierarchy(ClassHierarchyProto.Node root) Deserialize a class hierarchy from a protocol buffer object.

Method Summary

Methods

Modifier and Type	Method and Description
static ClassHierarchy	deserialize(File file) Deserialize a class hierarchy from a file.
Node	getNamespace() Return a reference to the root of the ClassHierarchy.
Node	getNode(String fullName) Lookup a node in this class hierarchy.
boolean	isImplementation(ClassNode<?> inter, ClassNode<?> impl)
ClassHierarchy	merge(ClassHierarchy ch) Merge the contents of this ClassHierarchy and the provided one into a new class hierarchy.
static ClassHierarchyProto.Node	serialize(ClassHierarchy classHierarchy) Serialize a class hierarchy into a protocol buffer object.
static void	serialize(File file, ClassHierarchy classHierarchy) serialize a class hierarchy into a file

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolBufferClassHierarchy

public ProtocolBufferClassHierarchy(ClassHierarchyProto.Node root)

Deserialize a class hierarchy from a protocol buffer object. The resulting object is immutable, and does not make use of reflection to fill in any missing values. This allows it to represent non-native classes as well as snapshots of Java class hierarchies.

Method Detail

serialize

public static ClassHierarchyProto.Node serialize(ClassHierarchy classHierarchy)

Serialize a class hierarchy into a protocol buffer object.

Parameters:

classHierarchy -

Returns:

serialize

public static void serialize(File file,
             ClassHierarchy classHierarchy)
                      throws IOException

serialize a class hierarchy into a file

Parameters:

file -

classHierarchy -

Throws:

IOException

deserialize

public static ClassHierarchy deserialize(File file)
                                  throws IOException

Deserialize a class hierarchy from a file. The file can be generated from either Java or C#

Parameters:

file -

Returns:

Throws:

IOException

getNode

public Node getNode(String fullName)
             throws NameResolutionException

Description copied from interface: ClassHierarchy

Lookup a node in this class hierarchy.

Specified by:

getNode in interface ClassHierarchy

Parameters:

fullName - The full name of the class that will be looked up.

Returns:

A non-null reference to a ClassNode or a NamedParameterNode.

Throws:

NameResolutionException - If the class is not found.

isImplementation

public boolean isImplementation(ClassNode<?> inter,
                       ClassNode<?> impl)

Specified by:

isImplementation in interface ClassHierarchy

Returns:

true if impl is a subclass of inter.

merge

public ClassHierarchy merge(ClassHierarchy ch)

Description copied from interface: ClassHierarchy

Merge the contents of this ClassHierarchy and the provided one into a new class hierarchy. This allows reflection information from multiple jars to be incorporated into a single ClassHierarchy object. Typical applications do not call this method, and instead provide classpath (or C# assembly) information to Tang when they create ConfigurationBuilder and Configuration objects. The Configuration API transparently invokes merge as necessary, allowing applications to combine configurations that were built against differing classpaths.

ClassHierarchies derived from applications written in different languages cannot be merged.

Specified by:

merge in interface ClassHierarchy

getNamespace

public Node getNamespace()

Description copied from interface: ClassHierarchy

Return a reference to the root of the ClassHierarchy. This is needed by serialization routines (which have to iterate over the ClassHierarchy's state). Unfortunately, due to limitations of Java, JavaClassHierarchy objects need to be built lazily as callers request classes by name. There is no way to provide an interface that enumerates known claases without exposing this fact; therefore, the Node returned by this method can change over time.

Normal callers (all use cases except ClassHierarchy serialization) should use getNode(String) to lookup classes, since getNamespace() can not support lazy loading of unknown classes.

Specified by:

getNamespace in interface ClassHierarchy

Returns:

a reference to the root node of this ClassHierarchy.