CacheRequest (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.net
class CacheRequest

java.lang.Object
  java.net.CacheRequest

public abstract class CacheRequest
extends Object

Represents channels for storing resources in the ResponseCache. Instances of such a class provide an OutputStream object which is called by protocol handlers to store the resource data into the cache, and also an abort() method which allows a cache store operation to be interrupted and abandoned. If an IOException is encountered while reading the response or writing to the cache, the current cache store operation will be aborted.

See Also (auto-generated):: ResponseCache

Constructor Summary
`CacheRequest()`

Method Summary
`abstract void`	`abort()` Aborts the attempt to cache the response.
`abstract OutputStream`	`getBody()` Returns an OutputStream to which the response body can be written.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

CacheRequest

public CacheRequest()

Method Detail

abort

public abstract void abort()

Aborts the attempt to cache the response. If an IOException is encountered while reading the response or writing to the cache, the current cache store operation will be abandoned.

getBody

public abstract OutputStream getBody()
                              throws IOException

Returns an OutputStream to which the response body can be written.

Returns:: an OutputStream to which the response body can be written
Throws:: IOException - if an I/O error occurs while writing the response body