com.screenscraper.util.parsing.pdf.pdftohtml

Class PdfToHtmlParseData

java.lang.Object

com.screenscraper.util.parsing.pdf.pdftohtml.PdfToHtmlParseData

public class PdfToHtmlParseData
extends java.lang.Object

Represents the data from a PDF to HTML parse

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
PdfToHtmlParseData() Creates the parse data object

Method Summary

Modifier and Type	Method and Description
(package private) void	addFile(java.io.File file) Adds a file that was generated
java.lang.Throwable	getException() Returns the Exception from parsing the file, or null if there wasn't an exception
java.util.List<java.io.File>	getFilesCreated() Returns a list of files associated with the parse.
org.jdom2.Element	getRootElement() Returns the root Element of the file, or null if the file didn't parse properly or there was no root
(package private) void	setException(java.lang.Throwable exception) Sets the Exception for the object
(package private) void	setRootElement(org.jdom2.Element rootElement) Sets the RootElement for the object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PdfToHtmlParseData

PdfToHtmlParseData()

Creates the parse data object

Method Detail

getException

@Nullable
public java.lang.Throwable getException()

Returns the Exception from parsing the file, or null if there wasn't an exception

Returns:

The Exception for the object

setException

void setException(@Nullable
                  java.lang.Throwable exception)

Sets the Exception for the object

Parameters:

exception - The new value for Exception

getRootElement

@Nullable
public org.jdom2.Element getRootElement()

Returns the root Element of the file, or null if the file didn't parse properly or there was no root

Returns:

The RootElement for the object

setRootElement

void setRootElement(@Nullable
                    org.jdom2.Element rootElement)

Sets the RootElement for the object

Parameters:

rootElement - The new value for RootElement

getFilesCreated

@NotNull
public java.util.List<java.io.File> getFilesCreated()

Returns a list of files associated with the parse. This will include the output xml file from PdfToHtml as well as any other files it generated. This is a best guess list, since PdfToHtml doesn't list the files it created. The returned list is not modifiable

Returns:

The files associated with the parse

addFile

void addFile(@NotNull
             java.io.File file)

Adds a file that was generated

Parameters:

file - The file that should be added