Class COSBoolean

  • All Implemented Interfaces:
    COSObjectable

    public class COSBoolean
    extends COSBase
    This class represents a boolean value in the PDF document.
    Version:
    $Revision: 1.14 $
    Author:
    Ben Litchfield
    • Field Detail

      • TRUE_BYTES

        public static final byte[] TRUE_BYTES
        The true boolean token.
      • FALSE_BYTES

        public static final byte[] FALSE_BYTES
        The false boolean token.
      • TRUE

        public static final COSBoolean TRUE
        The PDF true value.
      • FALSE

        public static final COSBoolean FALSE
        The PDF false value.
    • Method Detail

      • getValue

        public boolean getValue()
        This will get the value that this object wraps.
        Returns:
        The boolean value of this object.
      • getValueAsObject

        public java.lang.Boolean getValueAsObject()
        This will get the value that this object wraps.
        Returns:
        The boolean value of this object.
      • getBoolean

        public static COSBoolean getBoolean​(boolean value)
        This will get the boolean value.
        Parameters:
        value - Parameter telling which boolean value to get.
        Returns:
        The single boolean instance that matches the parameter.
      • getBoolean

        public static COSBoolean getBoolean​(java.lang.Boolean value)
        This will get the boolean value.
        Parameters:
        value - Parameter telling which boolean value to get.
        Returns:
        The single boolean instance that matches the parameter.
      • accept

        public java.lang.Object accept​(ICOSVisitor visitor)
                                throws COSVisitorException
        visitor pattern double dispatch method.
        Specified by:
        accept in class COSBase
        Parameters:
        visitor - The object to notify when visiting this object.
        Returns:
        any object, depending on the visitor implementation, or null
        Throws:
        COSVisitorException - If an error occurs while visiting this object.
      • toString

        public java.lang.String toString()
        Return a string representation of this object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The string value of this object.
      • writePDF

        public void writePDF​(java.io.OutputStream output)
                      throws java.io.IOException
        This will write this object out to a PDF stream.
        Parameters:
        output - The stream to write this object out to.
        Throws:
        java.io.IOException - If an error occurs while writing out this object.