Class PDTextStream

  • All Implemented Interfaces:
    COSObjectable

    public class PDTextStream
    extends java.lang.Object
    implements COSObjectable
    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.
    Version:
    $Revision: 1.3 $
    Author:
    Ben Litchfield
    • Constructor Detail

      • PDTextStream

        public PDTextStream​(COSString str)
        Constructor.
        Parameters:
        str - The string parameter.
      • PDTextStream

        public PDTextStream​(java.lang.String str)
        Constructor.
        Parameters:
        str - The string parameter.
      • PDTextStream

        public PDTextStream​(COSStream str)
        Constructor.
        Parameters:
        str - The stream parameter.
    • Method Detail

      • createTextStream

        public static PDTextStream createTextStream​(COSBase base)
        This will create the text stream object. base must either be a string or a stream.
        Parameters:
        base - The COS text stream object.
        Returns:
        A PDTextStream that wraps the base object.
      • getCOSObject

        public COSBase getCOSObject()
        Convert this standard java object to a COS object.
        Specified by:
        getCOSObject in interface COSObjectable
        Returns:
        The cos object that matches this Java object.
      • getAsString

        public java.lang.String getAsString()
                                     throws java.io.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.
        Returns:
        This value as a string.
        Throws:
        java.io.IOException - If an IO error occurs while accessing the stream.
      • getAsStream

        public java.io.InputStream getAsStream()
                                        throws java.io.IOException
        This is the preferred way of getting data with this class as it uses a stream object.
        Returns:
        The stream object.
        Throws:
        java.io.IOException - If an IO error occurs while accessing the stream.