Module org.sejda.sambox

Package org.sejda.sambox.output

Class XrefStream

java.lang.Object

org.sejda.sambox.cos.COSBase

org.sejda.sambox.cos.COSDictionary

org.sejda.sambox.cos.COSStream

org.sejda.sambox.output.XrefStream

All Implemented Interfaces:

Closeable, AutoCloseable, COSObjectable, Encryptable

class XrefStream
extends COSStream

A COSStream that represent and xref stream as defined in Chap 7.5.8 of PDF 32000-1:2008

Field Summary

Fields inherited from class org.sejda.sambox.cos.COSDictionary

items

Constructor Summary

Constructors

Constructor	Description
XrefStream(COSDictionary dictionary, PDFWriteContext context)	Creates an xref stream from the given dictionary.

Method Summary

Modifier and Type	Method	Description
private static DirectCOSObject	asDirect(long num)
boolean	encryptable()
void	encryptable(boolean encryptable)	Sets if the object can be encrypted
void	setEncryptor(Function<InputStream,InputStream> encryptor)	Sets the function to be used to encrypt this stream.
private static int	sizeOf(long number)

Methods inherited from class org.sejda.sambox.cos.COSStream

accept, addCompression, asTextString, close, createFilteredStream, createFilteredStream, createUnfilteredStream, doGetFilteredStream, getDecodeResult, getFilteredLength, getFilteredSource, getFilteredStream, getFilters, getUnfilteredByteBuffer, getUnfilteredLength, getUnfilteredSource, getUnfilteredStream, hasFilter, indirectLength, indirectLength, isEmpty, setFilters, unDecode

Methods inherited from class org.sejda.sambox.cos.COSDictionary

addAll, asUnmodifiableDictionary, clear, containsKey, containsKey, duplicate, entrySet, getBoolean, getBoolean, getBoolean, getCOSArray, getCOSName, getCOSName, getDate, getDate, getDate, getDate, getDictionaryObject, getDictionaryObject, getDictionaryObject, getDictionaryObject, getDictionaryObject, getDictionaryObject, getEmbeddedDate, getEmbeddedDate, getEmbeddedDate, getEmbeddedDate, getEmbeddedInt, getEmbeddedInt, getEmbeddedInt, getEmbeddedInt, getEmbeddedString, getEmbeddedString, getEmbeddedString, getEmbeddedString, getFlag, getFloat, getFloat, getFloat, getFloat, getInt, getInt, getInt, getInt, getInt, getInt, getItem, getItem, getItem, getKeyForValue, getLong, getLong, getLong, getLong, getNameAsString, getNameAsString, getNameAsString, getNameAsString, getString, getString, getString, getString, getValues, keySet, merge, mergeWithoutOverwriting, putIfAbsent, putIfAbsent, putIfAbsent, putIfAbsent, putIfAbsent, putIfAbsent, removeItem, removeItems, setBoolean, setBoolean, setDate, setDate, setEmbeddedDate, setEmbeddedDate, setEmbeddedInt, setEmbeddedInt, setEmbeddedString, setEmbeddedString, setFlag, setFloat, setFloat, setInt, setInt, setItem, setItem, setItem, setItem, setLong, setLong, setName, setName, setString, setString, size, toString

Methods inherited from class org.sejda.sambox.cos.COSBase

getCOSObject, hasId, id, idIfAbsent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

XrefStream

XrefStream(COSDictionary dictionary,
 PDFWriteContext context)
    throws IOException

Creates an xref stream from the given dictionary. The stream will contain all the entries that have been written using the given context

Parameters:

dictionary -

context -

Throws:

IOException

Method Details

asDirect

private static DirectCOSObject asDirect(long num)

encryptable

public boolean encryptable()

Specified by:

encryptable in interface Encryptable

Overrides:

encryptable in class COSStream

Returns:

true if the can be encrypted

encryptable

public void encryptable(boolean encryptable)

Description copied from interface: Encryptable

Sets if the object can be encrypted

Specified by:

encryptable in interface Encryptable

Overrides:

encryptable in class COSStream

setEncryptor

public void setEncryptor(Function<InputStream,InputStream> encryptor)

Description copied from class: COSStream

Sets the function to be used to encrypt this stream.

Overrides:

setEncryptor in class COSStream

sizeOf

private static int sizeOf(long number)