PDF to Text / Java Reference

class PdfToTextClient

All setter methods return PdfToTextClient object unless specified otherwise.

Constructor

public PdfToTextClient(String userName, String apiKey)
Constructor for the Pdfcrowd API client.
userName
Your username at Pdfcrowd.
apiKey
Your API key.

Conversion Input

public byte[] convertUrl(String url)
Convert a PDF.
url
The address of the PDF to convert.
The supported protocols are http:// and https://.
Returns
  • byte[] - Byte array containing the conversion output. 
public void convertUrlToStream(String url, OutputStream outStream)
Convert a PDF and write the result to an output stream.
url
The address of the PDF to convert.
The supported protocols are http:// and https://.
outStream
The output stream that will contain the conversion output. 
public void convertUrlToFile(String url, String filePath) throws IOException
Convert a PDF and write the result to a local file.
url
The address of the PDF to convert.
The supported protocols are http:// and https://.
filePath
The output file path. 
public byte[] convertFile(String file)
Convert a local file.
file
The path to a local file to convert.
The file must exist and not be empty.
Returns
  • byte[] - Byte array containing the conversion output. 
public void convertFileToStream(String file, OutputStream outStream)
Convert a local file and write the result to an output stream.
file
The path to a local file to convert.
The file must exist and not be empty.
outStream
The output stream that will contain the conversion output. 
public void convertFileToFile(String file, String filePath) throws IOException
Convert a local file and write the result to a local file.
file
The path to a local file to convert.
The file must exist and not be empty.
filePath
The output file path. 
public byte[] convertRawData(byte[] data)
Convert raw data.
data
The raw content to be converted.
Returns
  • byte[] - Byte array with the output. 
public void convertRawDataToStream(byte[] data, OutputStream outStream)
Convert raw data and write the result to an output stream.
data
The raw content to be converted.
outStream
The output stream that will contain the conversion output. 
public void convertRawDataToFile(byte[] data, String filePath) throws IOException
Convert raw data to a file.
data
The raw content to be converted.
filePath
The output file path. 
public byte[] convertStream(InputStream inStream) throws IOException
Convert the contents of an input stream.
inStream
The input stream with source data.
Returns
  • byte[] - Byte array containing the conversion output. 
public void convertStreamToStream(InputStream inStream, OutputStream outStream) throws IOException
Convert the contents of an input stream and write the result to an output stream.
inStream
The input stream with source data.
outStream
The output stream that will contain the conversion output. 
public void convertStreamToFile(InputStream inStream, String filePath) throws IOException
Convert the contents of an input stream and write the result to a local file.
inStream
The input stream with source data.
filePath
The output file path.

General Options

public PdfToTextClient setPdfPassword(String password)
The password to open the encrypted PDF file.
password
The input PDF password. 
public PdfToTextClient setPrintPageRange(String pages)
Set the page range to print.
pages
A comma separated list of page numbers or ranges.
Examples:
  • Just the second page is printed.
    setPrintPageRange("2")
  • The first and the third page are printed.
    setPrintPageRange("1,3")
  • Everything except the first page is printed.
    setPrintPageRange("2-")
  • Just first 3 pages are printed.
    setPrintPageRange("-3")
  • Pages 3, 6, 7, 8 and 9 are printed.
    setPrintPageRange("3,6-9") 
public PdfToTextClient setNoLayout(boolean value)
Ignore the original PDF layout.
value
Set to true to ignore the layout.
Default: false 
public PdfToTextClient setEol(String eol)
The end-of-line convention for the text output.
eol
Allowed values:
  • unix
    Unix convension "LF" is used.
  • dos
    Dos convension "CR LF" is used.
  • mac
    Mac convension "CR" is used.
Default: unix 
public PdfToTextClient setPageBreakMode(String mode)
Specify the page break mode for the text output.
mode
Allowed values:
  • none
    No page breaks are inserted.
  • default
    The standard page break code "FF" is used.
  • custom
    A custom page break is used.
Default: none 
public PdfToTextClient setCustomPageBreak(String pageBreak)
Specify the custom page break.
pageBreak
String to insert between the pages.
Examples:
  • setCustomPageBreak("END OF PAGE")
  • setCustomPageBreak("----my page break---- ") 
public PdfToTextClient setParagraphMode(String mode)
Specify the paragraph detection mode.
mode
Allowed values:
  • none
    No paragraph detection.
  • bounding-box
    Paragraph detection based on line bounding boxes.
  • characters
    Paragraph detection based on the number of characters in the line.
Default: none 
public PdfToTextClient setLineSpacingThreshold(String threshold)
Set the maximum line spacing when the paragraph detection mode is enabled.
threshold
The value must be a positive integer percentage.
Default: 10% 
public PdfToTextClient setRemoveHyphenation(boolean value)
Remove the hyphen character from the end of lines.
value
Set to true to remove hyphens.
Default: false 
public PdfToTextClient setRemoveEmptyLines(boolean value)
Remove empty lines from the text output.
value
Set to true to remove empty lines.
Default: false 
public PdfToTextClient setCropAreaX(int x)
Set the top left X coordinate of the crop area in points.
x
Must be a positive integer number or 0.
Default: 0
Example:
  • setCropAreaX(100) 
public PdfToTextClient setCropAreaY(int y)
Set the top left Y coordinate of the crop area in points.
y
Must be a positive integer number or 0.
Default: 0
Example:
  • setCropAreaY(100) 
public PdfToTextClient setCropAreaWidth(int width)
Set the width of the crop area in points.
width
Must be a positive integer number or 0.
Default: PDF page width.
Example:
  • setCropAreaWidth(100) 
public PdfToTextClient setCropAreaHeight(int height)
Set the height of the crop area in points.
height
Must be a positive integer number or 0.
Default: PDF page height.
Example:
  • setCropAreaHeight(100) 
public PdfToTextClient setCropArea(int x, int y, int width, int height)
Set the crop area. It allows to extract just a part of a PDF page.
x
Set the top left X coordinate of the crop area in points.
Must be a positive integer number or 0.
Default: 0
y
Set the top left Y coordinate of the crop area in points.
Must be a positive integer number or 0.
Default: 0
width
Set the width of the crop area in points.
Must be a positive integer number or 0.
Default: PDF page width.
height
Set the height of the crop area in points.
Must be a positive integer number or 0.
Default: PDF page height.

Miscellaneous

public PdfToTextClient setDebugLog(boolean value)
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
value
Set to true to enable the debug logging.
Default: false 
public String getDebugLogUrl()
Get the URL of the debug log for the last conversion.
Returns
  • String - The link to the debug log. 
public int getRemainingCreditCount()
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
Returns
  • int - The number of credits. 
public int getConsumedCreditCount()
Get the number of credits consumed by the last conversion.
Returns
  • int - The number of credits. 
public String getJobId()
Get the job id.
Returns
  • String - The unique job identifier. 
public int getPageCount()
Get the number of pages in the output document.
Returns
  • int - The page count. 
public int getOutputSize()
Get the size of the output in bytes.
Returns
  • int - The count of bytes. 
public String getVersion()
Get the version details.
Returns
  • String - API version, converter version, and client version. 
public PdfToTextClient setTag(String tag)
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
tag
A string with the custom tag.
Example:
  • setTag("client-1234") 
public PdfToTextClient setHttpProxy(String proxy)
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy
The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • setHttpProxy("myproxy.com:8080")
  • setHttpProxy("113.25.84.10:33333") 
public PdfToTextClient setHttpsProxy(String proxy)
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy
The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • setHttpsProxy("myproxy.com:443")
  • setHttpsProxy("113.25.84.10:44333")

API Client Options

public PdfToTextClient setUseHttp(boolean value)
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
value
Set to true to use HTTP.
Default: false

Warning

Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.

public PdfToTextClient setUserAgent(String agent)
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
agent
The user agent string.
Default: pdfcrowd_java_client/6.3.0 (https://pdfcrowd.com) 
public PdfToTextClient setProxy(String host, int port, String userName, String password)
Specifies an HTTP proxy that the API client library will use to connect to the internet.
host
The proxy hostname.
port
The proxy port.
userName
The username.
password
The password. 
public PdfToTextClient setRetryCount(int count)
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
count
Number of retries.
Default: 1
Example:
  • setRetryCount(3)