Package org.infinispan.stream.impl
Class IteratorResponses.IteratorResponsesExternalizer
- java.lang.Object
-
- org.infinispan.commons.marshall.AbstractExternalizer<IteratorResponses>
-
- org.infinispan.stream.impl.IteratorResponses.IteratorResponsesExternalizer
-
- All Implemented Interfaces:
Serializable
,org.infinispan.commons.marshall.AdvancedExternalizer<IteratorResponses>
,org.infinispan.commons.marshall.Externalizer<IteratorResponses>
- Enclosing class:
- IteratorResponses
public static class IteratorResponses.IteratorResponsesExternalizer extends org.infinispan.commons.marshall.AbstractExternalizer<IteratorResponses>
This externalizer is a special breed that converts a given response into others, based on whether or not an iterator has completed or not. This allows the originator to not have to create an intermediate collection to store the batched iterator and then the originator only has to create an object that requires given values.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description IteratorResponsesExternalizer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Integer
getId()
Returns an integer that identifies the externalizer type.Set<Class<? extends IteratorResponses>>
getTypeClasses()
Returns a collection of Class instances representing the types that this AdvancedExternalizer can marshall.IteratorResponses
readObject(ObjectInput input)
Read an instance from the stream.void
writeObject(ObjectOutput output, IteratorResponses object)
Write the object reference to the stream.
-
-
-
Method Detail
-
getId
public Integer getId()
Description copied from interface:org.infinispan.commons.marshall.AdvancedExternalizer
Returns an integer that identifies the externalizer type. This is used at read time to figure out whichAdvancedExternalizer
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 shippingAdvancedExternalizer
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 AdvancedExternalizer 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 interfaceorg.infinispan.commons.marshall.AdvancedExternalizer<IteratorResponses>
- Overrides:
getId
in classorg.infinispan.commons.marshall.AbstractExternalizer<IteratorResponses>
- Returns:
- A positive identifier for the AdvancedExternalizer.
-
getTypeClasses
public Set<Class<? extends IteratorResponses>> getTypeClasses()
Description copied from interface:org.infinispan.commons.marshall.AdvancedExternalizer
Returns a collection of Class instances representing the types that this AdvancedExternalizer can marshall. Clearly, empty sets are not allowed. The externalizer framework currently requires all individual types to be listed since it does not make assumptions based on super classes or interfaces.- Returns:
- A set containing the Class instances that can be marshalled.
-
writeObject
public void writeObject(ObjectOutput output, IteratorResponses object) throws IOException
Description copied from interface:org.infinispan.commons.marshall.Externalizer
Write the object reference to the stream.- Parameters:
output
- the object output to write toobject
- the object reference to write- Throws:
IOException
- if an I/O error occurs
-
readObject
public IteratorResponses readObject(ObjectInput input) throws IOException, ClassNotFoundException
Description copied from interface:org.infinispan.commons.marshall.Externalizer
Read an instance from the stream. The instance will have been written by theExternalizer.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.- Parameters:
input
- the object input to read from- Returns:
- the object instance
- Throws:
IOException
- if an I/O error occursClassNotFoundException
- if a class could not be found
-
-