Java Doc for PDMemoryStream.java in  » PDF » PDFBox-0.7.3 » org » pdfbox » pdmodel » common » 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.pdmodel.common 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.pdfbox.pdmodel.common.PDStream
      org.pdfbox.pdmodel.common.PDMemoryStream

PDMemoryStream
public class PDMemoryStream extends PDStream (Code)
A PDStream represents a stream in a PDF document. Streams are tied to a single PDF document.
author:
   Ben Litchfield
version:
   $Revision: 1.2 $



Constructor Summary
public  PDMemoryStream(byte[] buffer)
     This will create a new PDStream object.

Method Summary
public  voidaddCompression()
     If there are not compression filters on the current stream then this will add a compression filter, flate compression for example.
public  InputStreamcreateInputStream()
     This will get a stream that can be read from.
public  OutputStreamcreateOutputStream()
     This will get a stream that can be written to.
public  byte[]getByteArray()
     This will copy the stream into a byte array.
public  COSBasegetCOSObject()
     Convert this standard java object to a COS object.
public  ListgetDecodeParams()
     Get the list of decode parameters.
public  PDFileSpecificationgetFile()
     This will get the file specification for this stream.
public  ListgetFileDecodeParams()
     Get the list of decode parameters.
public  ListgetFileFilters()
     This will get the list of filters that are associated with this stream.
public  ListgetFilters()
     This will get the list of filters that are associated with this stream.
public  intgetLength()
     This will get the length of the filtered/compressed stream.
public  PDMetadatagetMetadata()
     Get the metadata that is part of the document catalog.
public  InputStreamgetPartiallyFilteredStream(List stopFilters)
     This will get a stream with some filters applied but not others.
public  COSStreamgetStream()
     Get the cos stream associated with this object.
public  voidsetDecodeParams(List decodeParams)
     This will set the list of decode params.
public  voidsetFile(PDFileSpecification f)
     Set the file specification.
public  voidsetFileDecodeParams(List decodeParams)
     This will set the list of decode params.
public  voidsetFileFilters(List filters)
     This will set the filters that are part of this stream.
public  voidsetFilters(List filters)
     This will set the filters that are part of this stream.
public  voidsetMetadata(PDMetadata meta)
     Set the metadata for this object.


Constructor Detail
PDMemoryStream
public PDMemoryStream(byte[] buffer)(Code)
This will create a new PDStream object.
Parameters:
  buffer - The data for this in memory stream.




Method Detail
addCompression
public void addCompression()(Code)
If there are not compression filters on the current stream then this will add a compression filter, flate compression for example.



createInputStream
public InputStream createInputStream() throws IOException(Code)
This will get a stream that can be read from. An input stream that can be read from.
throws:
  IOException - If an IO error occurs during reading.



createOutputStream
public OutputStream createOutputStream() throws IOException(Code)
This will get a stream that can be written to. An output stream to write data to.
throws:
  IOException - If an IO error occurs during writing.



getByteArray
public byte[] getByteArray() throws IOException(Code)
This will copy the stream into a byte array. The byte array of the filteredStream
throws:
  IOException - When getFilteredStream did not work



getCOSObject
public COSBase getCOSObject()(Code)
Convert this standard java object to a COS object. The cos object that matches this Java object.



getDecodeParams
public List getDecodeParams() throws IOException(Code)
Get the list of decode parameters. Each entry in the list will refer to an entry in the filters list. The list of decode parameters.
throws:
  IOException - if there is an error retrieving the parameters.



getFile
public PDFileSpecification getFile()(Code)
This will get the file specification for this stream. This is only required for external files. The file specification.



getFileDecodeParams
public List getFileDecodeParams() throws IOException(Code)
Get the list of decode parameters. Each entry in the list will refer to an entry in the filters list. The list of decode parameters.
throws:
  IOException - if there is an error retrieving the parameters.



getFileFilters
public List getFileFilters()(Code)
This will get the list of filters that are associated with this stream. Or null if there are none. A list of all encoding filters to apply to this stream.



getFilters
public List getFilters()(Code)
This will get the list of filters that are associated with this stream. Or null if there are none. A list of all encoding filters to apply to this stream.



getLength
public int getLength()(Code)
This will get the length of the filtered/compressed stream. This is readonly in the PD Model and will be managed by this class. The length of the filtered stream.



getMetadata
public PDMetadata getMetadata()(Code)
Get the metadata that is part of the document catalog. This will return null if there is no meta data for this object. The metadata for this object.



getPartiallyFilteredStream
public InputStream getPartiallyFilteredStream(List stopFilters) throws IOException(Code)
This will get a stream with some filters applied but not others. This is useful when doing images, ie filters = [flate,dct], we want to remove flate but leave dct
Parameters:
  stopFilters - A list of filters to stop decoding at. A stream with decoded data.
throws:
  IOException - If there is an error processing the stream.



getStream
public COSStream getStream()(Code)
Get the cos stream associated with this object. The cos object that matches this Java object.



setDecodeParams
public void setDecodeParams(List decodeParams)(Code)
This will set the list of decode params.
Parameters:
  decodeParams - The list of decode params.



setFile
public void setFile(PDFileSpecification f)(Code)
Set the file specification.
Parameters:
  f - The file specification.



setFileDecodeParams
public void setFileDecodeParams(List decodeParams)(Code)
This will set the list of decode params.
Parameters:
  decodeParams - The list of decode params.



setFileFilters
public void setFileFilters(List filters)(Code)
This will set the filters that are part of this stream.
Parameters:
  filters - The filters that are part of this stream.



setFilters
public void setFilters(List filters)(Code)
This will set the filters that are part of this stream.
Parameters:
  filters - The filters that are part of this stream.



setMetadata
public void setMetadata(PDMetadata meta)(Code)
Set the metadata for this object. This can be null.
Parameters:
  meta - The meta data for this object.



Methods inherited from org.pdfbox.pdmodel.common.PDStream
public void addCompression()(Code)(Java Doc)
public static PDStream createFromCOS(COSBase base) throws IOException(Code)(Java Doc)
public InputStream createInputStream() throws IOException(Code)(Java Doc)
public OutputStream createOutputStream() throws IOException(Code)(Java Doc)
public byte[] getByteArray() throws IOException(Code)(Java Doc)
public COSBase getCOSObject()(Code)(Java Doc)
public List getDecodeParams() throws IOException(Code)(Java Doc)
public PDFileSpecification getFile() throws IOException(Code)(Java Doc)
public List getFileDecodeParams() throws IOException(Code)(Java Doc)
public List getFileFilters()(Code)(Java Doc)
public List getFilters()(Code)(Java Doc)
public String getInputStreamAsString() throws IOException(Code)(Java Doc)
public int getLength()(Code)(Java Doc)
public PDMetadata getMetadata()(Code)(Java Doc)
public InputStream getPartiallyFilteredStream(List stopFilters) throws IOException(Code)(Java Doc)
public COSStream getStream()(Code)(Java Doc)
public void setDecodeParams(List decodeParams)(Code)(Java Doc)
public void setFile(PDFileSpecification f)(Code)(Java Doc)
public void setFileDecodeParams(List decodeParams)(Code)(Java Doc)
public void setFileFilters(List filters)(Code)(Java Doc)
public void setFilters(List filters)(Code)(Java Doc)
public void setMetadata(PDMetadata meta)(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.