Package com.pdfgate

Class PdfGateDocument

java.lang.Object

com.pdfgate.PdfGateDocument

public final class PdfGateDocument
extends Object

Document metadata returned by JSON responses from the PDFGate API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PdfGateDocument.DocumentStatus	Status values returned by the API for document processing.
static enum	PdfGateDocument.DocumentType	Document type values returned by the API.

Constructor Summary

Constructors

Constructor	Description
PdfGateDocument()	Creates an empty document instance for JSON deserialization.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Instant	getCreatedAt()	Returns when the document was created.
Optional<String>	getDerivedFrom()	Returns the source document ID when derived from another document.
Instant	getExpiresAt()	Returns when the document expires, if present.
Optional<String>	getFileUrl()	Returns a temporary file URL if provided by the API.
String	getId()	Returns the document identifier.
Optional<Map<String,Object>>	getMetadata()	Returns metadata attached to the document, if present.
Long	getSize()	Returns the file size in bytes, if provided.
PdfGateDocument.DocumentStatus	getStatus()	Returns the document processing status.
PdfGateDocument.DocumentType	getType()	Returns the document type.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Details

PdfGateDocument

public PdfGateDocument()

Creates an empty document instance for JSON deserialization.

Method Details

getId

public String getId()

Returns the document identifier.

Returns:

the document identifier.

getStatus

public PdfGateDocument.DocumentStatus getStatus()

Returns the document processing status.

Returns:

the document processing status.

getCreatedAt

public Instant getCreatedAt()

Returns when the document was created.

Returns:

when the document was created.

getExpiresAt

public Instant getExpiresAt()

Returns when the document expires, if present.

Returns:

when the document expires, if present.

getType

public PdfGateDocument.DocumentType getType()

Returns the document type.

Returns:

the document type.

getFileUrl

public Optional<String> getFileUrl()

Returns a temporary file URL if provided by the API.

Returns:

a temporary file URL if provided by the API.

getSize

public Long getSize()

Returns the file size in bytes, if provided.

Returns:

the file size in bytes, if provided.

getMetadata

public Optional<Map<String,Object>> getMetadata()

Returns metadata attached to the document, if present.

Returns:

metadata attached to the document, if present.

getDerivedFrom

public Optional<String> getDerivedFrom()

Returns the source document ID when derived from another document.

Returns:

the source document ID when derived from another document.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object