Package org.apache.pdfbox.pdmodel.common

Class PDNamedTextStream

java.lang.Object

org.apache.pdfbox.pdmodel.common.PDNamedTextStream

All Implemented Interfaces:

DualCOSObjectable

public class PDNamedTextStream
extends java.lang.Object
implements DualCOSObjectable

A named text stream is a combination of a name and a PDTextStream object. This is used in name trees.

Version:

$Revision: 1.3 $

Author:

Ben Litchfield

Constructor Summary

Constructors

Constructor	Description
PDNamedTextStream()	Constructor.
PDNamedTextStream(COSName name, COSBase str)	Constructor.

Method Summary

Modifier and Type	Method	Description
COSBase	getFirstCOSObject()	Convert this standard java object to a COS object.
java.lang.String	getName()	The name of the named text stream.
COSBase	getSecondCOSObject()	Convert this standard java object to a COS object.
PDTextStream	getStream()	This will get the stream.
void	setName(java.lang.String name)	This will set the name of the named text stream.
void	setStream(PDTextStream str)	This will set the stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

PDNamedTextStream

public PDNamedTextStream()

Constructor.

PDNamedTextStream

public PDNamedTextStream(COSName name,
                         COSBase str)

Constructor.

Parameters:

name - The name of the stream.

str - The stream.

Method Detail

getName

public java.lang.String getName()

The name of the named text stream.

Returns:

The stream name.

setName

public void setName(java.lang.String name)

This will set the name of the named text stream.

Parameters:

name - The name of the named text stream.

getStream

public PDTextStream getStream()

This will get the stream.

Returns:

The stream associated with this name.

setStream

public void setStream(PDTextStream str)

This will set the stream.

Parameters:

str - The stream associated with this name.

getFirstCOSObject

public COSBase getFirstCOSObject()

Convert this standard java object to a COS object.

Specified by:

getFirstCOSObject in interface DualCOSObjectable

Returns:

The cos object that matches this Java object.

getSecondCOSObject

public COSBase getSecondCOSObject()

Convert this standard java object to a COS object.

Specified by:

getSecondCOSObject in interface DualCOSObjectable

Returns:

The cos object that matches this Java object.