Package net.webpdf.wsclient.openapi

Class OperationExtractionInfo

java.lang.Object

net.webpdf.wsclient.openapi.OperationExtractionInfo

public class OperationExtractionInfo
extends Object

Extract general and structure information about the PDF document Generates an XML or JSON file that will be returned as a result when the web service is called. This file will contain information about the PDF document such as the corresponding security settings, PDF properties, or PDF/A status.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationExtractionInfo.FileFormatEnum	Used to define the output format for the PDF document text contents being extracted

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_FILE_FORMAT
static String	JSON_PROPERTY_PAGES

Constructor Summary

Constructors

Constructor	Description
OperationExtractionInfo()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
OperationExtractionInfo	fileFormat(OperationExtractionInfo.FileFormatEnum fileFormat)
@Nullable OperationExtractionInfo.FileFormatEnum	getFileFormat()	Used to define the output format for the PDF document text contents being extracted
@Nullable String	getPages()	Used to define which page(s) should be used for the extraction mode.
int	hashCode()
OperationExtractionInfo	pages(String pages)
void	setFileFormat(OperationExtractionInfo.FileFormatEnum fileFormat)
void	setPages(String pages)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_FILE_FORMAT

public static final String JSON_PROPERTY_FILE_FORMAT

See Also:

Constant Field Values

JSON_PROPERTY_PAGES

public static final String JSON_PROPERTY_PAGES

See Also:

Constant Field Values

Constructor Detail

OperationExtractionInfo

public OperationExtractionInfo()

Method Detail

fileFormat

public OperationExtractionInfo fileFormat(OperationExtractionInfo.FileFormatEnum fileFormat)

getFileFormat

@Nullable
public @Nullable OperationExtractionInfo.FileFormatEnum getFileFormat()

Used to define the output format for the PDF document text contents being extracted. * text = Text document * xml = XML document * json = JSON data structure

Returns:

fileFormat

setFileFormat

public void setFileFormat(OperationExtractionInfo.FileFormatEnum fileFormat)

pages

public OperationExtractionInfo pages(String pages)

getPages

@Nullable
public @Nullable String getPages()

Used to define which page(s) should be used for the extraction mode. The page number can be either an individual page, a page range, or a list (separated with commas) (e.g., \"1,5-6,9\"). A blank value or \"\\*\" selects all pages of the PDF document.

Returns:

pages

setPages

public void setPages(String pages)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object