Skip navigation links

Overview | Package | Class | Tree | Index | Help
| Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.tangosol.util.processor
Class PreloadRequest

`java.lang.Object
com.tangosol.util.Base
com.tangosol.util.processor.AbstractProcessor
com.tangosol.util.processor.PreloadRequest`

All Implemented Interfaces:
  ExternalizableLite, PortableObject, InvocableMap.EntryProcessor, Serializable

      public class PreloadRequest

extends AbstractProcessor
implements ExternalizableLite, PortableObject

PreloadRequest is a simple EntryProcessor that performs a `Entry.getValue` call. No results are reported back to the caller. <p/> The PreloadRequest process provides a means to "pre-load" an entry or a collection of entries into the cache using the cache's loader without incurring the cost of sending the value(s) over the network. If the corresponding entry (or entries) already exists in the cache, or if the cache does not have a loader, then invoking this EntryProcessor has no effect.

Since:
  Coherence 3.2
Author:
  gg 2006.04.28

Field Summary
`static PreloadRequest` | `INSTANCE` An instance of the PreloadRequest processor.

Constructor Summary
`PreloadRequest()` Construct the PreloadRequest processor.

Method Summary
`boolean` | `equals(Object o)` Compare the PreloadRequest with another object to determine equality.
`int` | `hashCode()` Determine a hash value for the PreloadRequest object according to the general `Object.hashCode()` contract.
`Object` | `process(InvocableMap.Entry entry)` Process a Map.Entry object.
`Map` | `processAll(Set setEntries)` Process a Set of InvocableMap.Entry objects. This method is semantically equivalent to:
       Map mapResults = new ListMap();
       for (Iterator iter = setEntries.iterator(); iter.hasNext(); )
           {
           Entry entry = (Entry) iter.next();
           mapResults.put(entry.getKey(), process(entry));
           }
       return mapResults;
Note: if processAll() call throws an exception, entries that were removed from the setEntries would be considered successfully processed and corresponding changes will be made to the underlying Map.
`void` | `readExternal(DataInput in)` Restore the contents of this object by loading the object's state from the passed DataInput object.
`void` | `readExternal(PofReader in)` Restore the contents of a user type instance by reading its state using the specified PofReader object.
`String` | `toString()` Return a human-readable description for this PreloadRequest processor.
`void` | `writeExternal(DataOutput out)` Save the contents of this object by storing the object's state into the passed DataOutput object.
`void` | `writeExternal(PofWriter out)` Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Field Detail

### INSTANCE

    public static final PreloadRequest INSTANCE

  An instance of the PreloadRequest processor.

Constructor Detail

### PreloadRequest

    public PreloadRequest()

  Construct the PreloadRequest processor.

Method Detail

### process

    public Object process(InvocableMap.Entry entry)

  Process a Map.Entry object.
  Specified by:
    `process` in interface `InvocableMap.EntryProcessor`
  Parameters:
    `entry` - the Entry to process
  Returns:
    the result of the processing, if any

### processAll

    public Map processAll(Set setEntries)

  Process a Set of InvocableMap.Entry objects. This method is semantically equivalent to:

         Map mapResults = new ListMap();
         for (Iterator iter = setEntries.iterator(); iter.hasNext(); )
             {
             Entry entry = (Entry) iter.next();
             mapResults.put(entry.getKey(), process(entry));
             }
         return mapResults;

  Note: if processAll() call throws an exception, entries that were removed from the setEntries would be considered successfully processed and corresponding changes will be made to the underlying Map.
  Specified by:
    `processAll` in interface `InvocableMap.EntryProcessor`
  Overrides:
    `processAll` in class `AbstractProcessor`
  Parameters:
    `setEntries` - a Set of InvocableMap.Entry objects to process
  Returns:
    a Map containing the results of the processing, up to one entry for each InvocableMap.Entry that was processed, keyed by the keys of the Map that were processed, with a corresponding value being the result of the processing for each key

### equals

    public boolean equals(Object o)

  Compare the PreloadRequest with another object to determine equality.
  Returns:
    true iff this PreloadRequest and the passed object are equivalent PreloadRequest objects

### hashCode

    public int hashCode()

  Determine a hash value for the PreloadRequest object according to the general `Object.hashCode()` contract.
  Returns:
    an integer hash value for this ConditionalPut object

### toString

    public String toString()

  Return a human-readable description for this PreloadRequest processor.
  Returns:
    a String description of the PreloadRequest processor

### readExternal

    public void readExternal(DataInput in)
                      throws IOException

  Restore the contents of this object by loading the object's state from the passed DataInput object.
  Specified by:
    `readExternal` in interface `ExternalizableLite`
  Parameters:
    `in` - the DataInput stream to read data from in order to restore the state of this object
  Throws:
    `IOException` - if an I/O exception occurs
    `NotActiveException` - if the object is not in its initial state, and therefore cannot be deserialized into

### writeExternal

    public void writeExternal(DataOutput out)
                       throws IOException

  Save the contents of this object by storing the object's state into the passed DataOutput object.
  Specified by:
    `writeExternal` in interface `ExternalizableLite`
  Parameters:
    `out` - the DataOutput stream to write the state of this object to
  Throws:
    `IOException` - if an I/O exception occurs

### readExternal

    public void readExternal(PofReader in)
                      throws IOException

  Restore the contents of a user type instance by reading its state using the specified PofReader object.
  Specified by:
    `readExternal` in interface `PortableObject`
  Parameters:
    `in` - the PofReader from which to read the object's state
  Throws:
    `IOException` - if an I/O error occurs

### writeExternal

    public void writeExternal(PofWriter out)
                       throws IOException

  Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
  Specified by:
    `writeExternal` in interface `PortableObject`
  Parameters:
    `out` - the PofWriter to which to write the object's state
  Throws:
    `IOException` - if an I/O error occurs

Skip navigation links

Overview | Package | Class | Tree | Index | Help
| Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.