com.biomatters.geneious.publicapi.plugin

Class DocumentSelectionOption.FolderOrDocuments

java.lang.Object

com.biomatters.geneious.publicapi.plugin.DocumentSelectionOption.FolderOrDocuments

Enclosing class:

DocumentSelectionOption

public static class DocumentSelectionOption.FolderOrDocuments
extends Object

The value type for DocumentSelectionOption which represents either a list of selected documents or a single selected folder which contains some documents of the correct type. To get the selected documents regardless of whether a folder is selected use DocumentSelectionOption.getDocuments().

Field Summary

Fields

Modifier and Type	Field and Description
static DocumentSelectionOption.FolderOrDocuments	EMPTY Represents an empty selection

Constructor Summary

Constructors

Constructor and Description
DocumentSelectionOption.FolderOrDocuments(AnnotatedPluginDocument document) Create a FolderOrDocuments for a selection of one document
DocumentSelectionOption.FolderOrDocuments(List<AnnotatedPluginDocument> documents) Create a FolderOrDocuments for a selection of documents
DocumentSelectionOption.FolderOrDocuments(WritableDatabaseService folder) Create a FolderOrDocuments for a folder selection

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
List<AnnotatedPluginDocument>	getDocuments() Get the selected documents or null if documents are not selected (a folder is selected).
WritableDatabaseService	getFolder() Get the selected folder or null if a folder was not selected (documents are selected).
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final DocumentSelectionOption.FolderOrDocuments EMPTY

Represents an empty selection

Constructor Detail

DocumentSelectionOption.FolderOrDocuments

public DocumentSelectionOption.FolderOrDocuments(WritableDatabaseService folder)

Create a FolderOrDocuments for a folder selection

Parameters:

folder - the selected folder

DocumentSelectionOption.FolderOrDocuments

public DocumentSelectionOption.FolderOrDocuments(List<AnnotatedPluginDocument> documents)

Create a FolderOrDocuments for a selection of documents

Parameters:

documents - the selected documents

DocumentSelectionOption.FolderOrDocuments

public DocumentSelectionOption.FolderOrDocuments(AnnotatedPluginDocument document)

Create a FolderOrDocuments for a selection of one document

Parameters:

document - the selected document

Method Detail

getFolder

public WritableDatabaseService getFolder()

Get the selected folder or null if a folder was not selected (documents are selected). Of getFolder() and getDocuments(), one will always return a non-null value while the other will return null.

To get the selected documents regardless of whether a folder is selected use DocumentSelectionOption.getDocuments().

Returns:

the selected folder or null if a folder is not selected (documents are selected)

getDocuments

public List<AnnotatedPluginDocument> getDocuments()

Get the selected documents or null if documents are not selected (a folder is selected). Of getFolder() and getDocuments(), one will always return a non-null value while the other will return null.

To get the selected documents regardless of whether a folder is selected use DocumentSelectionOption.getDocuments().

Returns:

the selected documents or null if documents are not selected (a folder is selected)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object