org.infinispan.distribution.ch
Class TopologyAwareConsistentHash.Externalizer

java.lang.Object
  extended by org.infinispan.marshall.AbstractExternalizer<T>
      extended by org.infinispan.distribution.ch.AbstractWheelConsistentHash.Externalizer<TopologyAwareConsistentHash>
          extended by org.infinispan.distribution.ch.TopologyAwareConsistentHash.Externalizer
All Implemented Interfaces:
Externalizer<TopologyAwareConsistentHash>
Enclosing class:
TopologyAwareConsistentHash

public static class TopologyAwareConsistentHash.Externalizer
extends AbstractWheelConsistentHash.Externalizer<TopologyAwareConsistentHash>


Constructor Summary
TopologyAwareConsistentHash.Externalizer()
           
 
Method Summary
 Integer getId()
          Returns an integer that identifies the externalizer type.
 Set<Class<? extends TopologyAwareConsistentHash>> getTypeClasses()
          Returns a collection of Class instances representing the types that this Externalizer can marshall.
protected  TopologyAwareConsistentHash instance()
           
 TopologyAwareConsistentHash readObject(ObjectInput unmarshaller)
          Read an instance from the stream.
 void writeObject(ObjectOutput output, TopologyAwareConsistentHash topologyAwareConsistentHash)
          Write the object reference to the stream.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TopologyAwareConsistentHash.Externalizer

public TopologyAwareConsistentHash.Externalizer()
Method Detail

instance

protected TopologyAwareConsistentHash instance()
Specified by:
instance in class AbstractWheelConsistentHash.Externalizer<TopologyAwareConsistentHash>

writeObject

public void writeObject(ObjectOutput output,
                        TopologyAwareConsistentHash topologyAwareConsistentHash)
                 throws IOException
Description copied from interface: Externalizer
Write the object reference to the stream.

Specified by:
writeObject in interface Externalizer<TopologyAwareConsistentHash>
Overrides:
writeObject in class AbstractWheelConsistentHash.Externalizer<TopologyAwareConsistentHash>
Parameters:
output - the object output to write to
topologyAwareConsistentHash - the object reference to write
Throws:
IOException - if an I/O error occurs

readObject

public TopologyAwareConsistentHash readObject(ObjectInput unmarshaller)
                                       throws IOException,
                                              ClassNotFoundException
Description copied from interface: Externalizer
Read an instance from the stream. The instance will have been written by the Externalizer.writeObject(ObjectOutput, Object) method. Implementations are free to create instances of the object read from the stream in any way that they feel like. This could be via constructor, factory or reflection.

Specified by:
readObject in interface Externalizer<TopologyAwareConsistentHash>
Overrides:
readObject in class AbstractWheelConsistentHash.Externalizer<TopologyAwareConsistentHash>
Parameters:
unmarshaller - the object input to read from
Returns:
the object instance
Throws:
IOException - if an I/O error occurs
ClassNotFoundException - if a class could not be found

getId

public Integer getId()
Description copied from interface: Externalizer
Returns an integer that identifies the externalizer type. This is used at read time to figure out which Externalizer should read the contents of the incoming buffer. Using a positive integer allows for very efficient variable length encoding of numbers, and it's much more efficient than shipping Externalizer implementation class information around. Negative values are not allowed. Implementers of this interface can use any positive integer as long as it does not clash with any other identifier in the system. You can find information on the pre-assigned identifier ranges in here. It's highly recommended that maintaining of these identifiers is done in a centralized way and you can do so by making annotations reference a set of statically defined identifiers in a separate class or interface. Such class/interface gives a global view of the identifiers in use and so can make it easier to assign new ids. Implementors can optionally avoid giving a meaningful implementation to this method (i.e. return null) and instead rely on XML or programmatic configuration to provide the Externalizer id. If no id can be determined via the implementation or XML/programmatic configuration, an error will be reported. If an id has been defined both via the implementation and XML/programmatic configuration, the value defined via XML/programmatic configuration will be used ignoring the other.

Specified by:
getId in interface Externalizer<TopologyAwareConsistentHash>
Overrides:
getId in class AbstractExternalizer<TopologyAwareConsistentHash>
Returns:
A positive identifier for the Externalizer.

getTypeClasses

public Set<Class<? extends TopologyAwareConsistentHash>> getTypeClasses()
Description copied from interface: Externalizer
Returns a collection of Class instances representing the types that this Externalizer can marshall. Clearly, empty sets are not allowed.

Returns:
A set containing the Class instances that can be marshalled.


Copyright © 2011 JBoss, a division of Red Hat. All Rights Reserved.