Java Doc for COSArray.java in  » PDF » PDFBox-0.7.3 » org » pdfbox » cos » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » PDF » PDFBox 0.7.3 » org.pdfbox.cos 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.pdfbox.cos.COSBase
      org.pdfbox.cos.COSArray

COSArray
public class COSArray extends COSBase (Code)
An array of PDFBase objects as part of the PDF document.
author:
   Ben Litchfield
version:
   $Revision: 1.24 $



Constructor Summary
public  COSArray()
     Constructor.

Method Summary
public  Objectaccept(ICOSVisitor visitor)
     visitor pattern double dispatch method.
Parameters:
  visitor - The object to notify when visiting this object.
public  voidadd(COSBase object)
     This will add an object to the array.
public  voidadd(COSObjectable object)
     This will add an object to the array.
public  voidadd(int i, COSBase object)
     Add the specified object at the ith location and push the rest to the right.
public  voidaddAll(Collection objectsList)
     This will add an object to the array.
public  voidaddAll(COSArray objectList)
     This will add all objects to this array.
public  voidaddAll(int i, Collection objectList)
     Add the specified object at the ith location and push the rest to the right.
public  voidclear()
     This will remove all of the objects in the collection.
public  COSBaseget(int index)
     This will get an object from the array.
public  intgetInt(int index)
     Get the value of the array as an integer.
Parameters:
  index - The index into the list.
public  intgetInt(int index, int defaultValue)
     Get the value of the array as an integer, return the default if it does not exist.
Parameters:
  index - The value of the array.
Parameters:
  defaultValue - The value to return if the value is null.
public  StringgetName(int index)
     Get the value of the array as a string.
Parameters:
  index - The index into the array.
public  StringgetName(int index, String defaultValue)
     Get an entry in the array that is expected to be a COSName.
Parameters:
  index - The index into the array.
Parameters:
  defaultValue - The value to return if it is null.
public  COSBasegetObject(int index)
     This will get an object from the array.
public  StringgetString(int index)
     Get the value of the array as a string.
Parameters:
  index - The index into the array.
public  StringgetString(int index, String defaultValue)
     Get an entry in the array that is expected to be a COSName.
Parameters:
  index - The index into the array.
Parameters:
  defaultValue - The value to return if it is null.
public  voidgrowToSize(int size)
     This will add null values until the size of the array is at least as large as the parameter.
public  voidgrowToSize(int size, COSBase object)
     This will add the object until the size of the array is at least as large as the parameter.
public  intindexOf(COSBase object)
     This will return the index of the entry or -1 if it is not found.
Parameters:
  object - The object to search for.
public  Iteratoriterator()
     Get access to the list.
public  COSBaseremove(int i)
     This will remove an element from the array.
Parameters:
  i - The index of the object to remove.
public  booleanremove(COSBase o)
     This will remove an element from the array.
Parameters:
  o - The object to remove.
public  voidremoveAll(Collection objectsList)
     This will remove all of the objects in the collection.
public  voidretainAll(Collection objectsList)
     This will retain all of the objects in the collection.
public  voidset(int index, COSBase object)
     This will set an object at a specific index.
public  voidset(int index, int intVal)
     This will set an object at a specific index.
public  voidset(int index, COSObjectable object)
     This will set an object at a specific index.
public  voidsetFloatArray(float[] value)
     Clear the current contents of the COSArray and set it with the float[].
public  voidsetInt(int index, int value)
     Set the value in the array as an integer.
public  voidsetName(int index, String name)
     Set the value in the array as a name.
public  voidsetString(int index, String string)
     Set the value in the array as a string.
public  intsize()
     This will get the size of this array.
public  float[]toFloatArray()
     This will take an COSArray of numbers and convert it to a float[].
public  StringtoString()
    


Constructor Detail
COSArray
public COSArray()(Code)
Constructor.




Method Detail
accept
public Object accept(ICOSVisitor visitor) throws COSVisitorException(Code)
visitor pattern double dispatch method.
Parameters:
  visitor - The object to notify when visiting this object. any object, depending on the visitor implementation, or null
throws:
  COSVisitorException - If an error occurs while visiting this object.



add
public void add(COSBase object)(Code)
This will add an object to the array.
Parameters:
  object - The object to add to the array.



add
public void add(COSObjectable object)(Code)
This will add an object to the array.
Parameters:
  object - The object to add to the array.



add
public void add(int i, COSBase object)(Code)
Add the specified object at the ith location and push the rest to the right.
Parameters:
  i - The index to add at.
Parameters:
  object - The object to add at that index.



addAll
public void addAll(Collection objectsList)(Code)
This will add an object to the array.
Parameters:
  objectsList - The object to add to the array.



addAll
public void addAll(COSArray objectList)(Code)
This will add all objects to this array.
Parameters:
  objectList - The objects to add.



addAll
public void addAll(int i, Collection objectList)(Code)
Add the specified object at the ith location and push the rest to the right.
Parameters:
  i - The index to add at.
Parameters:
  objectList - The object to add at that index.



clear
public void clear()(Code)
This will remove all of the objects in the collection.



get
public COSBase get(int index)(Code)
This will get an object from the array. This will NOT derefernce the COS object.
Parameters:
  index - The index into the array to get the object. The object at the requested index.



getInt
public int getInt(int index)(Code)
Get the value of the array as an integer.
Parameters:
  index - The index into the list. The value at that index or -1 if it is null.



getInt
public int getInt(int index, int defaultValue)(Code)
Get the value of the array as an integer, return the default if it does not exist.
Parameters:
  index - The value of the array.
Parameters:
  defaultValue - The value to return if the value is null. The value at the index or the defaultValue.



getName
public String getName(int index)(Code)
Get the value of the array as a string.
Parameters:
  index - The index into the array. The name converted to a string or null if it does not exist.



getName
public String getName(int index, String defaultValue)(Code)
Get an entry in the array that is expected to be a COSName.
Parameters:
  index - The index into the array.
Parameters:
  defaultValue - The value to return if it is null. The value at the index or defaultValue if none is found.



getObject
public COSBase getObject(int index)(Code)
This will get an object from the array. This will dereference the object. If the object is COSNull then null will be returned.
Parameters:
  index - The index into the array to get the object. The object at the requested index.



getString
public String getString(int index)(Code)
Get the value of the array as a string.
Parameters:
  index - The index into the array. The string or null if it does not exist.



getString
public String getString(int index, String defaultValue)(Code)
Get an entry in the array that is expected to be a COSName.
Parameters:
  index - The index into the array.
Parameters:
  defaultValue - The value to return if it is null. The value at the index or defaultValue if none is found.



growToSize
public void growToSize(int size)(Code)
This will add null values until the size of the array is at least as large as the parameter. If the array is already larger than the parameter then nothing is done.
Parameters:
  size - The desired size of the array.



growToSize
public void growToSize(int size, COSBase object)(Code)
This will add the object until the size of the array is at least as large as the parameter. If the array is already larger than the parameter then nothing is done.
Parameters:
  size - The desired size of the array.
Parameters:
  object - The object to fill the array with.



indexOf
public int indexOf(COSBase object)(Code)
This will return the index of the entry or -1 if it is not found.
Parameters:
  object - The object to search for. The index of the object or -1.



iterator
public Iterator iterator()(Code)
Get access to the list. an iterator over the array elements



remove
public COSBase remove(int i)(Code)
This will remove an element from the array.
Parameters:
  i - The index of the object to remove. The object that was removed.



remove
public boolean remove(COSBase o)(Code)
This will remove an element from the array.
Parameters:
  o - The object to remove. The object that was removed.



removeAll
public void removeAll(Collection objectsList)(Code)
This will remove all of the objects in the collection.
Parameters:
  objectsList - The list of objects to remove from the collection.



retainAll
public void retainAll(Collection objectsList)(Code)
This will retain all of the objects in the collection.
Parameters:
  objectsList - The list of objects to retain from the collection.



set
public void set(int index, COSBase object)(Code)
This will set an object at a specific index.
Parameters:
  index - zero based index into array.
Parameters:
  object - The object to set.



set
public void set(int index, int intVal)(Code)
This will set an object at a specific index.
Parameters:
  index - zero based index into array.
Parameters:
  intVal - The object to set.



set
public void set(int index, COSObjectable object)(Code)
This will set an object at a specific index.
Parameters:
  index - zero based index into array.
Parameters:
  object - The object to set.



setFloatArray
public void setFloatArray(float[] value)(Code)
Clear the current contents of the COSArray and set it with the float[].
Parameters:
  value - The new value of the float array.



setInt
public void setInt(int index, int value)(Code)
Set the value in the array as an integer.
Parameters:
  index - The index into the array.
Parameters:
  value - The value to set.



setName
public void setName(int index, String name)(Code)
Set the value in the array as a name.
Parameters:
  index - The index into the array.
Parameters:
  name - The name to set in the array.



setString
public void setString(int index, String string)(Code)
Set the value in the array as a string.
Parameters:
  index - The index into the array.
Parameters:
  string - The string to set in the array.



size
public int size()(Code)
This will get the size of this array. The number of elements in the array.



toFloatArray
public float[] toFloatArray()(Code)
This will take an COSArray of numbers and convert it to a float[]. This COSArray as an array of float numbers.



toString
public String toString()(Code)



Methods inherited from org.pdfbox.cos.COSBase
abstract public Object accept(ICOSVisitor visitor) throws COSVisitorException(Code)(Java Doc)
public COSBase getCOSObject()(Code)(Java Doc)
public FilterManager getFilterManager()(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.