Package net.webpdf.wsclient.openapi

Class MetadataFoldersDocument

java.lang.Object

net.webpdf.wsclient.openapi.MetadataFoldersDocument

public class MetadataFoldersDocument
extends Object

Lists the folders contained in a PDF collection (portfolio), that are used to structure the embedded attachments.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_FOLDER
static String	JSON_PROPERTY_INITIAL_FILE

Constructor Summary

Constructors

Constructor	Description
MetadataFoldersDocument()

Method Summary

Modifier and Type	Method	Description
MetadataFoldersDocument	addFolderItem(MetadataFolder folderItem)
boolean	equals(Object o)
MetadataFoldersDocument	folder(List<MetadataFolder> folder)
@Nullable List<MetadataFolder>	getFolder()	Get folder
@Nullable String	getInitialFile()	The object ID of the initially visible attachment.
int	hashCode()
MetadataFoldersDocument	initialFile(String initialFile)
void	setFolder(List<MetadataFolder> folder)
void	setInitialFile(String initialFile)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_FOLDER

public static final String JSON_PROPERTY_FOLDER

See Also:

Constant Field Values

JSON_PROPERTY_INITIAL_FILE

public static final String JSON_PROPERTY_INITIAL_FILE

See Also:

Constant Field Values

Constructor Detail

MetadataFoldersDocument

public MetadataFoldersDocument()

Method Detail

folder

public MetadataFoldersDocument folder(List<MetadataFolder> folder)

addFolderItem

public MetadataFoldersDocument addFolderItem(MetadataFolder folderItem)

getFolder

@Nullable
public @Nullable List<MetadataFolder> getFolder()

Get folder

Returns:

folder

setFolder

public void setFolder(List<MetadataFolder> folder)

initialFile

public MetadataFoldersDocument initialFile(String initialFile)

getInitialFile

@Nullable
public @Nullable String getInitialFile()

The object ID of the initially visible attachment. **Info:** A PDF object ID consists of two numbers, where the first number selects the object's number and the second the \"generation\" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.

Returns:

initialFile

setInitialFile

public void setInitialFile(String initialFile)

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