Module org.sejda.sambox

Package org.sejda.sambox.pdmodel

Interface ResourceCache

All Known Implementing Classes:

DefaultResourceCache

public interface ResourceCache

A document-wide cache for page resources.

Author:

John Hewson

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the cache
PDColorSpace	getColorSpace(COSObjectKey key)	Returns the color space resource for the given key object, if it is in the cache.
PDExtendedGraphicsState	getExtGState(COSObjectKey key)	Returns the external graphics state resource for the given key object, if it is in the cache.
PDFont	getFont(COSObjectKey key)	Returns the font resource for the given key object, if it is in the cache.
PDAbstractPattern	getPattern(COSObjectKey key)	Returns the pattern resource for the given key object, if it is in the cache.
PDPropertyList	getProperties(COSObjectKey key)	Returns the property list resource for the given key object, if it is in the cache.
PDShading	getShading(COSObjectKey key)	Returns the shading resource for the given key object, if it is in the cache.
PDXObject	getXObject(COSObjectKey key)	Returns the XObject resource for the given key object, if it is in the cache.
void	put(COSObjectKey key, PDPropertyList propertyList)	Puts the given key property list resource in the cache.
void	put(COSObjectKey key, PDFont font)	Puts the given key font resource in the cache.
void	put(COSObjectKey key, PDColorSpace colorSpace)	Puts the given key color space resource in the cache.
void	put(COSObjectKey key, PDAbstractPattern pattern)	Puts the given key pattern resource in the cache.
void	put(COSObjectKey key, PDXObject xobject)	Puts the given key XObject resource in the cache.
void	put(COSObjectKey key, PDShading shading)	Puts the given key shading resource in the cache.
void	put(COSObjectKey key, PDExtendedGraphicsState extGState)	Puts the given key extended graphics state resource in the cache.

Method Details

getFont

PDFont getFont(COSObjectKey key)
        throws IOException

Returns the font resource for the given key object, if it is in the cache.

Throws:

IOException

getColorSpace

PDColorSpace getColorSpace(COSObjectKey key)
                    throws IOException

Returns the color space resource for the given key object, if it is in the cache.

Throws:

IOException

getExtGState

PDExtendedGraphicsState getExtGState(COSObjectKey key)

Returns the external graphics state resource for the given key object, if it is in the cache.

getShading

PDShading getShading(COSObjectKey key)
              throws IOException

Returns the shading resource for the given key object, if it is in the cache.

Throws:

IOException

getPattern

PDAbstractPattern getPattern(COSObjectKey key)
                      throws IOException

Returns the pattern resource for the given key object, if it is in the cache.

Throws:

IOException

getProperties

PDPropertyList getProperties(COSObjectKey key)

Returns the property list resource for the given key object, if it is in the cache.

getXObject

PDXObject getXObject(COSObjectKey key)
              throws IOException

Returns the XObject resource for the given key object, if it is in the cache.

Throws:

IOException

put

void put(COSObjectKey key,
 PDFont font)
  throws IOException

Puts the given key font resource in the cache.

Throws:

IOException

put

void put(COSObjectKey key,
 PDColorSpace colorSpace)
  throws IOException

Puts the given key color space resource in the cache.

Throws:

IOException

put

void put(COSObjectKey key,
 PDExtendedGraphicsState extGState)

Puts the given key extended graphics state resource in the cache.

put

void put(COSObjectKey key,
 PDShading shading)
  throws IOException

Puts the given key shading resource in the cache.

Throws:

IOException

put

void put(COSObjectKey key,
 PDAbstractPattern pattern)
  throws IOException

Puts the given key pattern resource in the cache.

Throws:

IOException

put

void put(COSObjectKey key,
 PDPropertyList propertyList)

Puts the given key property list resource in the cache.

put

void put(COSObjectKey key,
 PDXObject xobject)
  throws IOException

Puts the given key XObject resource in the cache.

Throws:

IOException

clear

void clear()

Clears the cache