org.pdfbox.pdmodel.common
Class PDTextStream
java.lang.Object
org.pdfbox.pdmodel.common.PDTextStream
- COSObjectable
public class PDTextStream
extends java.lang.Object
A PDTextStream class is used when the PDF specification supports either
a string or a stream for the value of an object. This is usually when
a value could be large or small, for example a JavaScript method. This
class will help abstract that and give a single unified interface to
those types of fields.
PDTextStream
public PDTextStream(String str)
Constructor.
str
- The string parameter.
PDTextStream
public PDTextStream(COSStream str)
Constructor.
str
- The stream parameter.
PDTextStream
public PDTextStream(COSString str)
Constructor.
str
- The string parameter.
createTextStream
public static PDTextStream createTextStream(COSBase base)
This will create the text stream object. base must either be a string
or a stream.
base
- The COS text stream object.
- A PDTextStream that wraps the base object.
getAsStream
public InputStream getAsStream()
throws IOException
This is the preferred way of getting data with this class as it uses
a stream object.
getAsString
public String getAsString()
throws IOException
This will get this value as a string. If this is a stream then it
will load the entire stream into memory, so you should only do this when
the stream is a manageable size.
getCOSObject
public COSBase getCOSObject()
Convert this standard java object to a COS object.
- getCOSObject in interface COSObjectable
- The cos object that matches this Java object.