Java Doc for COSString.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.COSString

COSString
public class COSString extends COSBase (Code)
This represents a string object in a PDF document.
author:
   Ben Litchfield
version:
   $Revision: 1.29 $


Field Summary
final public static  byte[]BS_ESCAPE
     BS escape characters.
final public static  byte[]CR_ESCAPE
     CR escape characters.
final public static  byte[]ESCAPE
     the escape character in strings.
final public static  byte[]FF_ESCAPE
     FF escape characters.
final public static  byte[]HEX_STRING_CLOSE
     One of the close string tokens.
final public static  byte[]HEX_STRING_OPEN
     One of the open string tokens.
final public static  byte[]HT_ESCAPE
     HT escape characters.
final public static  byte[]LF_ESCAPE
     LF escape characters.
final public static  byte[]STRING_CLOSE
     One of the close string tokens.
final public static  byte[]STRING_OPEN
     One of the open string tokens.

Constructor Summary
public  COSString()
     Constructor.
public  COSString(String value)
     Explicit constructor for ease of manual PDF construction.
public  COSString(byte[] value)
     Explicit constructor for ease of manual PDF construction.

Method Summary
public  Objectaccept(ICOSVisitor visitor)
     visitor pattern double dispatch method.
Parameters:
  visitor - The object to notify when visiting this object.
public  voidappend(byte[] data)
     This will append a byte[] to the string.
public  voidappend(int in)
     This will append a byte to the string.
public static  COSStringcreateFromHexString(String hex)
     This will create a COS string from a string of hex characters.
Parameters:
  hex - A hex string.
public  booleanequals(Object obj)
    
public  byte[]getBytes()
     This will get the bytes of the string.
public  StringgetHexString()
     This will take this string and create a hex representation of the bytes that make the string.
public  StringgetString()
     This will get the string that this object wraps.
public  inthashCode()
    
public  voidreset()
     This will reset the internal buffer.
public  voidsetForceLiteralForm(boolean v)
     Forces the string to be written in literal form instead of hexadecimal form.
public  StringtoString()
    
public  voidwritePDF(OutputStream output)
     This will output this string as a PDF object.

Field Detail
BS_ESCAPE
final public static byte[] BS_ESCAPE(Code)
BS escape characters.



CR_ESCAPE
final public static byte[] CR_ESCAPE(Code)
CR escape characters.



ESCAPE
final public static byte[] ESCAPE(Code)
the escape character in strings.



FF_ESCAPE
final public static byte[] FF_ESCAPE(Code)
FF escape characters.



HEX_STRING_CLOSE
final public static byte[] HEX_STRING_CLOSE(Code)
One of the close string tokens.



HEX_STRING_OPEN
final public static byte[] HEX_STRING_OPEN(Code)
One of the open string tokens.



HT_ESCAPE
final public static byte[] HT_ESCAPE(Code)
HT escape characters.



LF_ESCAPE
final public static byte[] LF_ESCAPE(Code)
LF escape characters.



STRING_CLOSE
final public static byte[] STRING_CLOSE(Code)
One of the close string tokens.



STRING_OPEN
final public static byte[] STRING_OPEN(Code)
One of the open string tokens.




Constructor Detail
COSString
public COSString()(Code)
Constructor.



COSString
public COSString(String value)(Code)
Explicit constructor for ease of manual PDF construction.
Parameters:
  value - The string value of the object.



COSString
public COSString(byte[] value)(Code)
Explicit constructor for ease of manual PDF construction.
Parameters:
  value - The string value of the object.




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.



append
public void append(byte[] data) throws IOException(Code)
This will append a byte[] to the string.
Parameters:
  data - The byte[] to add to this string.
throws:
  IOException - If an IO error occurs while writing the byte.



append
public void append(int in) throws IOException(Code)
This will append a byte to the string.
Parameters:
  in - The byte to add to this string.
throws:
  IOException - If an IO error occurs while writing the byte.



createFromHexString
public static COSString createFromHexString(String hex) throws IOException(Code)
This will create a COS string from a string of hex characters.
Parameters:
  hex - A hex string. A cos string with the hex characters converted to their actual bytes.
throws:
  IOException - If there is an error with the hex string.



equals
public boolean equals(Object obj)(Code)



getBytes
public byte[] getBytes()(Code)
This will get the bytes of the string. A byte array that represents the string.



getHexString
public String getHexString()(Code)
This will take this string and create a hex representation of the bytes that make the string. A hex string representing the bytes in this string.



getString
public String getString()(Code)
This will get the string that this object wraps. The wrapped string.



hashCode
public int hashCode()(Code)



reset
public void reset()(Code)
This will reset the internal buffer.



setForceLiteralForm
public void setForceLiteralForm(boolean v)(Code)
Forces the string to be written in literal form instead of hexadecimal form.
Parameters:
  v - if v is true the string will be written in literal form, otherwise it willbe written in hexa if necessary.



toString
public String toString()(Code)



writePDF
public void writePDF(OutputStream output) throws IOException(Code)
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.



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.