Return-Path: X-Original-To: apmail-pdfbox-commits-archive@www.apache.org Delivered-To: apmail-pdfbox-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 39C161913E for ; Sat, 26 Mar 2016 08:52:53 +0000 (UTC) Received: (qmail 33266 invoked by uid 500); 26 Mar 2016 08:52:53 -0000 Delivered-To: apmail-pdfbox-commits-archive@pdfbox.apache.org Received: (qmail 33216 invoked by uid 500); 26 Mar 2016 08:52:53 -0000 Mailing-List: contact commits-help@pdfbox.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@pdfbox.apache.org Delivered-To: mailing list commits@pdfbox.apache.org Received: (qmail 32514 invoked by uid 99); 26 Mar 2016 08:52:52 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 26 Mar 2016 08:52:52 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 98DEBE00B4; Sat, 26 Mar 2016 08:52:52 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: msahyoun@apache.org To: commits@pdfbox.apache.org Date: Sat, 26 Mar 2016 08:53:19 -0000 Message-Id: In-Reply-To: <8dcbb3761fd649ccaf5b58c4bb164560@git.apache.org> References: <8dcbb3761fd649ccaf5b58c4bb164560@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [29/51] [partial] pdfbox-docs git commit: PDFBOX-3291: add 1.8.11 javadoc http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/37d0891c/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNull.html ---------------------------------------------------------------------- diff --git a/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNull.html b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNull.html new file mode 100644 index 0000000..9d314de --- /dev/null +++ b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNull.html @@ -0,0 +1,331 @@ + + + + + + +COSNull (Apache PDFBox 1.8.11 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.apache.pdfbox.cos
+

Class COSNull

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    COSObjectable
    +
    +
    +
    +
    public class COSNull
+extends COSBase
    +
    This class represents a null PDF object.
    +
    Version:
    +
    $Revision: 1.13 $
    +
    Author:
    +
    Ben Litchfield
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        NULL_BYTES

        +
        public static final byte[] NULL_BYTES
        +
        The null token.
        +
        • +
      + + + +
        +
      • +

        NULL

        +
        public static final COSNull NULL
        +
        The one null object in the system.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        accept

        +
        public 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.
        +
        • +
      + + + +
        +
      • +

        writePDF

        +
        public void writePDF(OutputStream output)
+              throws IOException
        +
        This will output this string as a PDF object.
        +
        Parameters:
        output - The stream to write to.
        +
        Throws:
        +
        IOException - If there is an error writing to the stream.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2002-2016 The Apache Software Foundation. All Rights Reserved.

+ + http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/37d0891c/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNumber.html ---------------------------------------------------------------------- diff --git a/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNumber.html b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNumber.html new file mode 100644 index 0000000..777a089 --- /dev/null +++ b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNumber.html @@ -0,0 +1,418 @@ + + + + + + +COSNumber (Apache PDFBox 1.8.11 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.apache.pdfbox.cos
+

Class COSNumber

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    COSObjectable
    +
    +
    +
    Direct Known Subclasses:
    +
    COSFloat, COSInteger
    +
    +
    +
    +
    public abstract class COSNumber
+extends COSBase
    +
    This class represents an abstract number in a PDF document.
    +
    Version:
    +
    $Revision: 1.10 $
    +
    Author:
    +
    Ben Litchfield
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        COSNumber

        +
        public COSNumber()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        floatValue

        +
        public abstract float floatValue()
        +
        This will get the float value of this number.
        +
        Returns:
        The float value of this object.
        +
        • +
      + + + +
        +
      • +

        doubleValue

        +
        public abstract double doubleValue()
        +
        This will get the double value of this number.
        +
        Returns:
        The double value of this number.
        +
        • +
      + + + +
        +
      • +

        intValue

        +
        public abstract int intValue()
        +
        This will get the integer value of this number.
        +
        Returns:
        The integer value of this number.
        +
        • +
      + + + +
        +
      • +

        longValue

        +
        public abstract long longValue()
        +
        This will get the long value of this number.
        +
        Returns:
        The long value of this number.
        +
        • +
      + + + +
        +
      • +

        get

        +
        public static COSNumber get(String number)
+                     throws IOException
        +
        This factory method will get the appropriate number object.
        +
        Parameters:
        number - The string representation of the number.
        +
        Returns:
        A number object, either float or int.
        +
        Throws:
        +
        IOException - If the string is not a number.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2002-2016 The Apache Software Foundation. All Rights Reserved.

+ + http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/37d0891c/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSObject.html ---------------------------------------------------------------------- diff --git a/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSObject.html b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSObject.html new file mode 100644 index 0000000..881914a --- /dev/null +++ b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSObject.html @@ -0,0 +1,457 @@ + + + + + + +COSObject (Apache PDFBox 1.8.11 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.apache.pdfbox.cos
+

Class COSObject

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    COSObjectable
    +
    +
    +
    +
    public class COSObject
+extends COSBase
    +
    This class represents a PDF object.
    +
    Version:
    +
    $Revision: 1.37 $
    +
    Author:
    +
    Ben Litchfield
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        COSObject

        +
        public COSObject(COSBase object)
+          throws IOException
        +
        Constructor.
        +
        Parameters:
        object - The object that this encapsulates.
        +
        Throws:
        +
        IOException - If there is an error with the object passed in.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDictionaryObject

        +
        public COSBase getDictionaryObject(COSName key)
        +
        This will get the dictionary object in this object that has the name key and + if it is a pdfobjref then it will dereference that and return it.
        +
        Parameters:
        key - The key to the value that we are searching for.
        +
        Returns:
        The pdf object that matches the key.
        +
        • +
      + + + +
        +
      • +

        getItem

        +
        public COSBase getItem(COSName key)
        +
        This will get the dictionary object in this object that has the name key.
        +
        Parameters:
        key - The key to the value that we are searching for.
        +
        Returns:
        The pdf object that matches the key.
        +
        • +
      + + + +
        +
      • +

        getObject

        +
        public COSBase getObject()
        +
        This will get the object that this object encapsulates.
        +
        Returns:
        The encapsulated object.
        +
        • +
      + + + +
        +
      • +

        setObject

        +
        public void setObject(COSBase object)
+               throws IOException
        +
        This will set the object that this object encapsulates.
        +
        Parameters:
        object - The new object to encapsulate.
        +
        Throws:
        +
        IOException - If there is an error setting the updated object.
        +
        • +
      + + + + + + + +
        +
      • +

        getObjectNumber

        +
        public COSInteger getObjectNumber()
        +
        Getter for property objectNumber.
        +
        Returns:
        Value of property objectNumber.
        +
        • +
      + + + +
        +
      • +

        setObjectNumber

        +
        public void setObjectNumber(COSInteger objectNum)
        +
        Setter for property objectNumber.
        +
        Parameters:
        objectNum - New value of property objectNumber.
        +
        • +
      + + + +
        +
      • +

        getGenerationNumber

        +
        public COSInteger getGenerationNumber()
        +
        Getter for property generationNumber.
        +
        Returns:
        Value of property generationNumber.
        +
        • +
      + + + +
        +
      • +

        setGenerationNumber

        +
        public void setGenerationNumber(COSInteger generationNumberValue)
        +
        Setter for property generationNumber.
        +
        Parameters:
        generationNumberValue - New value of property generationNumber.
        +
        • +
      + + + +
        +
      • +

        accept

        +
        public 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.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2002-2016 The Apache Software Foundation. All Rights Reserved.

+ +