Package org.apache.hc.client5.http.cache
Class Resource
- java.lang.Object
-
- org.apache.hc.client5.http.cache.Resource
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
FileResource
,HeapResource
@Contract(threading=SAFE) public abstract class Resource extends java.lang.Object implements java.io.Serializable
Represents a disposable system resource used for handling cached response bodies.Implementations of this interface are expected to be threading-safe.
- Since:
- 4.1
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private static long
serialVersionUID
-
Constructor Summary
Constructors Constructor Description Resource()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
dispose()
Indicates the system no longer needs to keep this response body and any system resources associated with it may be reclaimed.abstract byte[]
get()
Returns resource content as a byte array.java.io.InputStream
getInputStream()
Returns resource content as anInputStream
.abstract long
length()
Returns the length in bytes of the response body.
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
-
Method Detail
-
getInputStream
public java.io.InputStream getInputStream() throws ResourceIOException
Returns resource content as anInputStream
.- Throws:
ResourceIOException
-
get
public abstract byte[] get() throws ResourceIOException
Returns resource content as a byte array.Please note for memory efficiency some resource implementations may return a reference to the underlying byte array. The returned value should be treated as immutable.
- Throws:
ResourceIOException
- Since:
- 5.0
-
length
public abstract long length()
Returns the length in bytes of the response body.
-
dispose
public abstract void dispose()
Indicates the system no longer needs to keep this response body and any system resources associated with it may be reclaimed.
-
-