org.pdfclown.objects.PdfStream Class Reference

PDF stream object [PDF:1.6:3.2.7]. More...

Inheritance diagram for org.pdfclown.objects.PdfStream:

Public Member Functions
override PdfObject	Accept (IVisitor visitor, object data)
	Accepts a visit.
virtual PdfObject	Clone (File context)
	Creates a deep copy of this object within the specified file context.
object	Clone ()
	Creates a shallow copy of this object.
IBuffer	GetBody (bool decode)
	Gets the stream body.
	PdfStream (PdfDictionary header, IBuffer body)
	PdfStream (IBuffer body)
	PdfStream (PdfDictionary header)
	PdfStream ()
PdfDataObject	Resolve ()
	Ensures this object to be resolved into its corresponding data object.
void	SetDataFile (FileSpecification value, bool preserve)
override PdfObject	Swap (PdfObject other)
	Swaps contents between this object and the other one.
PdfDirectObject	Unresolve ()
	Ensures this object to be unresolved into its corresponding indirect reference, if available.
override void	WriteTo (IOutputStream stream, File context)
	Serializes this object to the specified stream.
Static Public Member Functions
static PdfObject	Clone (PdfObject @object, File context)
	Gets the clone of the specified object, registered inside the specified file context.
static PdfDataObject	Resolve (PdfObject @object)
	Ensures an indirect reference to be resolved into its corresponding data object.
static PdfDirectObject	Unresolve (PdfDataObject @object)
	Ensures a data object to be unresolved into its corresponding indirect reference, if available.
Protected Member Functions
internal void	Update ()
	Updates the state of this object.
Properties
IBuffer	Body `[get]`
	Gets the decoded stream body.
virtual PdfIndirectObject	Container `[get]`
	Gets the indirect object containing this object.
PdfIndirectObject	DataContainer `[get]`
	Gets the indirect object containing the data associated to this object.
FileSpecification	DataFile `[get, set]`
	Gets/Sets the file containing the object data.
virtual File	File `[get]`
	Gets the file containing this object.
PdfDirectObject	Filter `[get, set]`
PdfDictionary	Header `[get]`
	Gets the stream header.
virtual PdfIndirectObject	IndirectObject `[get]`
	Gets the indirect object corresponding to this object.
PdfDirectObject	Parameters `[get, set]`
override PdfObject	Parent `[get, set]`
	Gets/Sets the parent of this object.
virtual PdfReference	Reference `[get]`
	Gets the indirect reference of this object.
override bool	Updateable `[get, set]`
	Gets/Sets whether the detection of object state changes is enabled.
override bool	Updated `[get, set]`
	Gets/Sets whether the initial state of this object has been modified.
internal override bool	Virtual `[get, set]`
	Gets/Sets whether this object acts like a null-object placeholder.

PDF stream object [PDF:1.6:3.2.7].

Constructor & Destructor Documentation

org.pdfclown.objects.PdfStream.PdfStream ( )

org.pdfclown.objects.PdfStream.PdfStream ( PdfDictionary header )

org.pdfclown.objects.PdfStream.PdfStream ( IBuffer body )

org.pdfclown.objects.PdfStream.PdfStream	(	PdfDictionary	header,
		IBuffer	body
	)

References org.pdfclown.bytes.IBuffer.Dirty, and org.pdfclown.bytes.IBuffer.OnChange.

Member Function Documentation

override PdfObject org.pdfclown.objects.PdfStream.Accept	(	IVisitor	visitor,
		object	data
	)			`[virtual]`

Accepts a visit.

Parameters:

	visitor	Visiting object.
	data	Supplemental data.

Returns:: Result object.

Implements org.pdfclown.objects.PdfObject.

Reimplemented in org.pdfclown.tokens.ObjectStream, and org.pdfclown.tokens.XRefStream.

References org.pdfclown.objects.IVisitor.Visit().

virtual PdfObject org.pdfclown.objects.PdfObject.Clone ( File context ) [virtual, inherited]

Creates a deep copy of this object within the specified file context.

Reimplemented in org.pdfclown.objects.PdfSimpleObject< TValue >.

References org.pdfclown.files.File.Cloner.

object org.pdfclown.objects.PdfObject.Clone ( ) [inherited]

Creates a shallow copy of this object.

References org.pdfclown.objects.PdfObject.Parent.

static PdfObject org.pdfclown.objects.PdfObject.Clone	(	PdfObject @	object,
		File	context
	)			`[static, inherited]`

Gets the clone of the specified object, registered inside the specified file context.

Parameters:

	object	Object to clone into the specified file context.
	context	File context of the cloning.

Referenced by org.pdfclown.objects.PdfObjectWrapper< PdfTextString >.Clone(), and org.pdfclown.objects.Cloner.Visit().

IBuffer org.pdfclown.objects.PdfStream.GetBody ( bool decode )

Gets the stream body.

Parameters:

decode

Defines whether the body has to be decoded.

References org.pdfclown.documents.files.FileSpecification.GetInputStream(), and org.pdfclown.objects.PdfDictionary.Updateable.

PdfDataObject org.pdfclown.objects.PdfObject.Resolve ( ) [inherited]

Ensures this object to be resolved into its corresponding data object.

See also:: Unresolve()

References org.pdfclown.objects.PdfReference.DataObject.

static PdfDataObject org.pdfclown.objects.PdfObject.Resolve ( PdfObject @ object ) [static, inherited]

Ensures an indirect reference to be resolved into its corresponding data object.

Parameters:

object

Object to resolve.

void org.pdfclown.objects.PdfStream.SetDataFile	(	FileSpecification	value,
		bool	preserve
	)

Parameters:

preserve

Indicates whether the data from the old data source substitutes the new one. This way data can be imported to/exported from local or preserved in case of external file location changed.