Index (Dataverse SPI Plugin API Reference)

A B C D E F G H I K L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

abortOnCompatibilityProblems() - Method in class io.gdcc.spi.core.loader.LoaderConfiguration: When enabled, plugin loading aborts on discovered compatibility problems (for example, API level mismatches).
abortOnDuplicatedIdentities() - Method in class io.gdcc.spi.core.loader.LoaderConfiguration: When enabled, loading aborts if duplicate plugin identities are detected.
addDatasetPredicate(DatasetMetadataPredicates) - Method in class io.gdcc.spi.export.DatasetExportQuery.Builder: Adds a dataset metadata predicate to the builder's collection of predicates.
addFilePredicate(FileMetadataPredicates) - Method in class io.gdcc.spi.export.FileExportQuery.Builder: Adds a file metadata predicate to the builder's collection of predicates.
ALL_FILES - Enum constant in enum class io.gdcc.spi.export.FileMetadataPredicates: Includes metadata for all files without restriction.
API_LEVEL - Static variable in interface io.gdcc.spi.export.ExportDataProvider
API_LEVEL - Static variable in interface io.gdcc.spi.export.Exporter
API_LEVEL - Static variable in interface io.gdcc.spi.export.XMLExporter
API_LEVEL_FIELD_NAME - Static variable in class io.gdcc.spi.meta.processor.ProcessorConstants: Name of the compile-time constant field carrying the contract version.
AUTO_SERVICE_ANNOTATION - Static variable in class io.gdcc.spi.meta.processor.ProcessorConstants: Fully qualified name of @AutoService.

B

BASE - Enum constant in enum class io.gdcc.spi.meta.annotations.PluginContract.Role: A directly loadable plugin contract.
build() - Method in class io.gdcc.spi.export.DatasetExportQuery.Builder: Builds an immutable DatasetExportQuery.
build() - Method in class io.gdcc.spi.export.FileExportQuery.Builder: Builds an immutable FileExportQuery.
builder() - Static method in class io.gdcc.spi.export.DatasetExportQuery: Returns a builder for creating new queries.
builder() - Static method in class io.gdcc.spi.export.FileExportQuery: Returns a builder for creating new queries.

C

CAPABILITY - Enum constant in enum class io.gdcc.spi.meta.annotations.PluginContract.Role: An additional plugin capability that refines behavior but is not directly loadable.
cause() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.LocationFailure: Returns the value of the cause record component.
cause() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.SourceFailure: Returns the value of the cause record component.
checkConflicts(Set<DatasetMetadataPredicates>) - Static method in enum class io.gdcc.spi.export.DatasetMetadataPredicates: Checks for conflicts among the given set of dataset metadata predicates.
checkConflicts(Set<FileMetadataPredicates>) - Static method in enum class io.gdcc.spi.export.FileMetadataPredicates: Checks for conflicts among the given set of export file predicates.
classname() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMismatch: Returns the value of the classname record component.
classname() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMissing: Returns the value of the classname record component.
classname() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderApiLevelMismatch: Returns the value of the classname record component.
className() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.MissingServiceProviderRecord: Returns the value of the className record component.
className() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassMismatch: Returns the value of the className record component.
className() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassNameCollision: Returns the value of the className record component.
className() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassNameCollisionWithCore: Returns the value of the className record component.
className() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassUnsupported: Returns the value of the className record component.
className() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderClassUnsupported: Returns the value of the className record component.
conflictsWith(DatasetMetadataPredicates) - Method in enum class io.gdcc.spi.export.DatasetMetadataPredicates: Returns true if this predicate conflicts with the given predicate.
conflictsWith(FileMetadataPredicates) - Method in enum class io.gdcc.spi.export.FileMetadataPredicates
CONTRACT_PREFIX - Static variable in class io.gdcc.spi.meta.descriptor.DescriptorFormat
CONTRACT_SUFFIX - Static variable in class io.gdcc.spi.meta.descriptor.DescriptorFormat
contractClass() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMissing: Returns the value of the contractClass record component.
contractLevel(Class<?>) - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Returns the declared API level for the given implemented contract, if present.
contractLevel(Class<? extends Plugin>) - Method in record class io.gdcc.spi.meta.descriptor.PluginDescriptor
contractLevel(String) - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Returns the declared API level for the given implemented contract, if present.
contracts() - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Returns the value of the contracts record component.
contracts() - Method in record class io.gdcc.spi.meta.descriptor.PluginDescriptor: Returns the value of the contracts record component.
CORE_PROVIDER_INTERFACE - Static variable in class io.gdcc.spi.meta.processor.ProcessorConstants: Fully qualified name of the common provider super-interface.
coreLevel() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMismatch: Returns the value of the coreLevel record component.
coreLevel() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMissing: Returns the value of the coreLevel record component.
coreLevel() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderApiLevelMismatch: Returns the value of the coreLevel record component.
CoreProvider - Interface in io.gdcc.spi.meta.plugin: Represents a provider interface for core functionality within the plugin system.

D

DatasetExportQuery - Class in io.gdcc.spi.export: Defines what dataset metadata to retrieve and at what level of detail for dataset-oriented export operations.
DatasetExportQuery.Builder - Class in io.gdcc.spi.export: Builder for DatasetExportQuery.
DatasetMetadataPredicates - Enum Class in io.gdcc.spi.export: Predicates for controlling which dataset metadata is included in an export and at what level of detail.
datasetPredicates(DatasetMetadataPredicates...) - Method in class io.gdcc.spi.export.DatasetExportQuery.Builder: Sets the dataset metadata predicates, replacing any previously set predicates.
datasetPredicates(Collection<DatasetMetadataPredicates>) - Method in class io.gdcc.spi.export.DatasetExportQuery.Builder: Sets the dataset metadata predicates, replacing any previously set predicates.
DataversePlugin - Annotation Interface in io.gdcc.spi.meta.annotations: Marks a concrete plugin implementation class for metadata generation.
defaults() - Static method in class io.gdcc.spi.core.loader.LoaderConfiguration: Returns the standard loader configuration (which is strictly enforcing).
defaults() - Static method in class io.gdcc.spi.export.DatasetExportQuery: Returns the default query, which includes all dataset metadata with no special filtering, and defers file metadata shaping to method-level defaults.
defaults() - Static method in class io.gdcc.spi.export.FileExportQuery: Returns a default query, which includes all files without filtering or detail restrictions.
descriptor() - Method in record class io.gdcc.spi.core.loader.PluginHandle: Returns the value of the descriptor record component.
Descriptor - Record Class in io.gdcc.spi.meta.descriptor: In-memory representation of raw metadata de/serialized from a Dataverse Plugin Metadata file.
Descriptor(String, String, Map<String, Integer>, Map<String, Integer>) - Constructor for record class io.gdcc.spi.meta.descriptor.Descriptor: Creates a new plugin and defensively copies the contract/provider maps.
DESCRIPTOR_DIRECTORY - Static variable in class io.gdcc.spi.meta.descriptor.DescriptorFormat
DESCRIPTOR_EXTENSION - Static variable in class io.gdcc.spi.meta.descriptor.DescriptorFormat
DescriptorFormat - Class in io.gdcc.spi.meta.descriptor: Defines constants for the format and structure of plugin plugin files.
DescriptorScanner - Class in io.gdcc.spi.meta.descriptor
duplicate() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.DuplicateIdentity: Returns the value of the duplicate record component.
DuplicateIdentity(String, PluginDescriptor<?>, PluginDescriptor<?>) - Constructor for record class io.gdcc.spi.core.loader.LoaderProblem.DuplicateIdentity: Creates an instance of a DuplicateIdentity record class.

E

emitWarningsOnMultiPluginSource() - Method in class io.gdcc.spi.core.loader.LoaderConfiguration: When LoaderConfiguration.enforceSingleSourceMatchingPluginsOnly() is disabled, controls whether multi-plugin-contract sources should emit warnings.
enforceSingleSourceMatchingPluginsOnly() - Method in class io.gdcc.spi.core.loader.LoaderConfiguration: When enabled, a source may only provide plugins for a single requested base contract.
enforceUnambiguousPluginIdentities() - Method in class io.gdcc.spi.core.loader.LoaderConfiguration: When enabled, plugin identities must be unique within a source.
equals(Object) - Method in record class io.gdcc.spi.core.loader.LoaderProblem.DuplicateIdentity: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.gdcc.spi.core.loader.LoaderProblem.LocationFailure: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.gdcc.spi.core.loader.LoaderProblem.MissingServiceProviderRecord: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMismatch: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMissing: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassMismatch: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassNameCollision: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassNameCollisionWithCore: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassUnsupported: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderApiLevelMismatch: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderClassUnsupported: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.gdcc.spi.core.loader.LoaderProblem.SourceFailure: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.gdcc.spi.core.loader.PluginHandle: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class io.gdcc.spi.export.DatasetExportQuery
equals(Object) - Method in class io.gdcc.spi.export.FileExportQuery
equals(Object) - Method in class io.gdcc.spi.export.PageRequest
equals(Object) - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.gdcc.spi.meta.descriptor.PluginDescriptor: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.gdcc.spi.meta.descriptor.SourcedDescriptor: Indicates whether some other object is "equal to" this one.
ExportDataProvider - Interface in io.gdcc.spi.export: Provides dataset metadata that can be used by an Exporter to create new metadata export formats.
exportDataset(ExportDataProvider, OutputStream) - Method in interface io.gdcc.spi.export.Exporter: When this method is called, the Exporter should write the metadata to the given OutputStream.
Exporter - Interface in io.gdcc.spi.export: Dataverse allows new metadata export formats to be dynamically added a running instance.
ExportException - Exception in io.gdcc.spi.export
ExportException(String) - Constructor for exception io.gdcc.spi.export.ExportException
ExportException(String, Throwable) - Constructor for exception io.gdcc.spi.export.ExportException

F

FileExportQuery - Class in io.gdcc.spi.export: Defines what file metadata to retrieve and at what level of detail for file-oriented export operations.
FileExportQuery.Builder - Class in io.gdcc.spi.export: Builder for FileExportQuery.
FileMetadataPredicates - Enum Class in io.gdcc.spi.export: Enum representing predicates for filtering file metadata during export operations.
filePredicates(FileMetadataPredicates...) - Method in class io.gdcc.spi.export.FileExportQuery.Builder: Sets the file metadata predicates, replacing any previously set predicates.
filePredicates(Collection<FileMetadataPredicates>) - Method in class io.gdcc.spi.export.FileExportQuery.Builder: Sets the file metadata predicates, replacing any previously set predicates.
fileQuery(FileExportQuery) - Method in class io.gdcc.spi.export.DatasetExportQuery.Builder: Sets the FileExportQuery to use for shaping file metadata nested within this dataset query.
from(DatasetExportQuery) - Method in class io.gdcc.spi.export.DatasetExportQuery.Builder: Creates a new DatasetExportQuery.Builder pre-populated with the state of the given query, useful for deriving a modified copy without altering the original.
from(FileExportQuery) - Method in class io.gdcc.spi.export.FileExportQuery.Builder: Copies the properties from the given FileExportQuery instance into a new Builder.

G

getDataCiteXml() - Method in interface io.gdcc.spi.export.ExportDataProvider: Deprecated, for removal: This API element is subject to removal in a future version.
since 2.1.0, for removal in 3.0.0. Use ExportDataProvider.getDataCiteXml(DatasetExportQuery) instead.
getDataCiteXml(DatasetExportQuery) - Method in interface io.gdcc.spi.export.ExportDataProvider: Returns dataset metadata conforming to the DataCite standard as XML.
getDatasetFileDetails() - Method in interface io.gdcc.spi.export.ExportDataProvider: Deprecated, for removal: This API element is subject to removal in a future version.
since 2.1.0, for removal in 3.0.0. Use ExportDataProvider.getDatasetFileDetails(FileExportQuery) or ExportDataProvider.getDatasetFileDetails(FileExportQuery, PageRequest)instead.
getDatasetFileDetails(FileExportQuery) - Method in interface io.gdcc.spi.export.ExportDataProvider: Returns detailed metadata for files in the dataset.
getDatasetFileDetails(FileExportQuery, PageRequest) - Method in interface io.gdcc.spi.export.ExportDataProvider: Returns detailed metadata for files in the dataset.
getDatasetJson() - Method in interface io.gdcc.spi.export.ExportDataProvider: Deprecated, for removal: This API element is subject to removal in a future version.
since 2.1.0, for removal in 3.0.0. Use ExportDataProvider.getDatasetJson(DatasetExportQuery) instead.
getDatasetJson(DatasetExportQuery) - Method in interface io.gdcc.spi.export.ExportDataProvider: Returns complete dataset metadata in Dataverse's standard JSON format.
getDatasetORE() - Method in interface io.gdcc.spi.export.ExportDataProvider: Deprecated, for removal: This API element is subject to removal in a future version.
since 2.1.0, for removal in 3.0.0. Use ExportDataProvider.getDatasetORE(DatasetExportQuery) instead.
getDatasetORE(DatasetExportQuery) - Method in interface io.gdcc.spi.export.ExportDataProvider: Returns dataset metadata in JSON-LD-based OAI-ORE format.
getDatasetPredicates() - Method in class io.gdcc.spi.export.DatasetExportQuery: Returns the dataset metadata predicates that control which aspects of the dataset are included in the export.
getDatasetSchemaDotOrg() - Method in interface io.gdcc.spi.export.ExportDataProvider: Deprecated, for removal: This API element is subject to removal in a future version.
since 2.1.0, for removal in 3.0.0. Use ExportDataProvider.getDatasetSchemaDotOrg(DatasetExportQuery) instead.
getDatasetSchemaDotOrg(DatasetExportQuery) - Method in interface io.gdcc.spi.export.ExportDataProvider: Returns dataset metadata conforming to the schema.org standard.
getDisplayName(Locale) - Method in interface io.gdcc.spi.export.Exporter: This method should return the display name of the metadata format this Exporter provides.
getFilePredicates() - Method in class io.gdcc.spi.export.FileExportQuery: Returns the file metadata predicates that control which files are included and what level of detail is fetched for each.
getFileQuery() - Method in class io.gdcc.spi.export.DatasetExportQuery: Returns the optional FileExportQuery that controls how file metadata nested within this dataset export should be shaped.
getFormatName() - Method in interface io.gdcc.spi.export.Exporter: This method should return the name of the metadata format this Exporter provides.
getLimit() - Method in class io.gdcc.spi.export.PageRequest
getMediaType() - Method in interface io.gdcc.spi.export.Exporter: To support effective downloads of metadata in this Exporter's format, the Exporter should specify an appropriate mime type.
getMediaType() - Method in interface io.gdcc.spi.export.XMLExporter
getOffset() - Method in class io.gdcc.spi.export.PageRequest
getPrerequisiteFormatName() - Method in interface io.gdcc.spi.export.Exporter: Exporters can specify that they require, as input, the output of another exporter.
getPrerequisiteInputStream() - Method in interface io.gdcc.spi.export.ExportDataProvider: Deprecated, for removal: This API element is subject to removal in a future version.
since 2.1.0, for removal in 3.0.0. Use ExportDataProvider.getPrerequisiteInputStream(DatasetExportQuery) instead.
getPrerequisiteInputStream(DatasetExportQuery) - Method in interface io.gdcc.spi.export.ExportDataProvider: Returns metadata in the format specified by an Exporter's prerequisite.
getProblems() - Method in exception io.gdcc.spi.core.loader.LoaderException
getSupportedAnnotationTypes() - Method in class io.gdcc.spi.meta.processor.PluginContractProcessor: Returns the annotation types directly claimed by this processor.
getSupportedSourceVersion() - Method in class io.gdcc.spi.meta.processor.PluginContractProcessor: Advertises support for the latest source version understood by the current compiler.
getXMLNameSpace() - Method in interface io.gdcc.spi.export.XMLExporter
getXMLSchemaLocation() - Method in interface io.gdcc.spi.export.XMLExporter
getXMLSchemaVersion() - Method in interface io.gdcc.spi.export.XMLExporter

H

hashCode() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.DuplicateIdentity: Returns a hash code value for this object.
hashCode() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.LocationFailure: Returns a hash code value for this object.
hashCode() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.MissingServiceProviderRecord: Returns a hash code value for this object.
hashCode() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMismatch: Returns a hash code value for this object.
hashCode() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMissing: Returns a hash code value for this object.
hashCode() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassMismatch: Returns a hash code value for this object.
hashCode() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassNameCollision: Returns a hash code value for this object.
hashCode() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassNameCollisionWithCore: Returns a hash code value for this object.
hashCode() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassUnsupported: Returns a hash code value for this object.
hashCode() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderApiLevelMismatch: Returns a hash code value for this object.
hashCode() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderClassUnsupported: Returns a hash code value for this object.
hashCode() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.SourceFailure: Returns a hash code value for this object.
hashCode() - Method in record class io.gdcc.spi.core.loader.PluginHandle: Returns a hash code value for this object.
hashCode() - Method in class io.gdcc.spi.export.DatasetExportQuery
hashCode() - Method in class io.gdcc.spi.export.FileExportQuery
hashCode() - Method in class io.gdcc.spi.export.PageRequest
hashCode() - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Returns a hash code value for this object.
hashCode() - Method in record class io.gdcc.spi.meta.descriptor.PluginDescriptor: Returns a hash code value for this object.
hashCode() - Method in record class io.gdcc.spi.meta.descriptor.SourcedDescriptor: Returns a hash code value for this object.
hasServiceProviderInterfaceRecord(SourcedDescriptor) - Static method in class io.gdcc.spi.meta.descriptor.DescriptorScanner: Checks whether the source referenced by the given descriptor contains a Java SPI service configuration file for the descriptor's declared kind, and whether that file explicitly lists the descriptor's implementation class.

I

identity() - Method in interface io.gdcc.spi.export.Exporter
identity() - Method in record class io.gdcc.spi.meta.descriptor.PluginDescriptor: Returns the value of the identity record component.
identity() - Method in interface io.gdcc.spi.meta.plugin.Plugin: Returns the unique, machine-readable identifier for this plugin.
implementsContract(Class<?>) - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Checks whether this plugin declares the given implemented contract.
implementsContract(Class<? extends Plugin>) - Method in record class io.gdcc.spi.meta.descriptor.PluginDescriptor
implementsContract(String) - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Checks whether this plugin declares the given implemented contract.
INCLUDE_TABULAR_DATA_VARIABLES - Enum constant in enum class io.gdcc.spi.export.FileMetadataPredicates: For tabular data files, control if variable details are included or not.
init(ProcessingEnvironment) - Method in class io.gdcc.spi.meta.processor.PluginContractProcessor: Initializes compiler utility helpers from the processing environment.
io.gdcc.spi.core.loader - package io.gdcc.spi.core.loader
io.gdcc.spi.export - package io.gdcc.spi.export
io.gdcc.spi.meta.annotations - package io.gdcc.spi.meta.annotations: Annotations used to declare Dataverse plugin contracts, plugin implementations, and required core providers.
io.gdcc.spi.meta.descriptor - package io.gdcc.spi.meta.descriptor
io.gdcc.spi.meta.plugin - package io.gdcc.spi.meta.plugin
io.gdcc.spi.meta.processor - package io.gdcc.spi.meta.processor
isAvailableToUsers() - Method in interface io.gdcc.spi.export.Exporter: If an Exporter is available to users, its format will be generated for every published dataset and made available via the dataset page/metadata tab/Metadata Exports menu item and via the API.
isHarvestable() - Method in interface io.gdcc.spi.export.Exporter: Harvestable Exporters will be available as options in Dataverse's Harvesting mechanism.
isOfKind(Class<?>) - Method in record class io.gdcc.spi.meta.descriptor.Descriptor
isOfKind(Class<?>) - Method in record class io.gdcc.spi.meta.descriptor.SourcedDescriptor
isOfKind(String) - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Determines whether this plugin is of a specified base contract kind.
isPaged() - Method in class io.gdcc.spi.export.PageRequest

K

kind() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.MissingServiceProviderRecord: Returns the value of the kind record component.
kind() - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Returns the value of the kind record component.
kindClass() - Method in record class io.gdcc.spi.meta.descriptor.PluginDescriptor: Returns the value of the kindClass record component.
klass() - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Returns the value of the klass record component.

L

load(Path) - Method in class io.gdcc.spi.core.loader.PluginLoader: Loads all plugins of type T from JAR files located in the specified directory.
LoaderConfiguration - Class in io.gdcc.spi.core.loader: Immutable configuration controlling the behavior of the plugin loader.
LoaderException - Exception in io.gdcc.spi.core.loader
LoaderException(List<LoaderProblem>) - Constructor for exception io.gdcc.spi.core.loader.LoaderException
LoaderProblem - Interface in io.gdcc.spi.core.loader
LoaderProblem.DuplicateIdentity - Record Class in io.gdcc.spi.core.loader
LoaderProblem.LocationFailure - Record Class in io.gdcc.spi.core.loader
LoaderProblem.MissingServiceProviderRecord - Record Class in io.gdcc.spi.core.loader
LoaderProblem.PluginClassApiLevelMismatch - Record Class in io.gdcc.spi.core.loader
LoaderProblem.PluginClassApiLevelMissing - Record Class in io.gdcc.spi.core.loader
LoaderProblem.PluginClassMismatch - Record Class in io.gdcc.spi.core.loader
LoaderProblem.PluginClassNameCollision - Record Class in io.gdcc.spi.core.loader
LoaderProblem.PluginClassNameCollisionWithCore - Record Class in io.gdcc.spi.core.loader
LoaderProblem.PluginClassUnsupported - Record Class in io.gdcc.spi.core.loader
LoaderProblem.ProviderApiLevelMismatch - Record Class in io.gdcc.spi.core.loader
LoaderProblem.ProviderClassUnsupported - Record Class in io.gdcc.spi.core.loader
LoaderProblem.SourceFailure - Record Class in io.gdcc.spi.core.loader
location() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.LocationFailure: Returns the value of the location record component.
LocationFailure(Path, Throwable) - Constructor for record class io.gdcc.spi.core.loader.LoaderProblem.LocationFailure: Creates an instance of a LocationFailure record class.

M

message() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.DuplicateIdentity
message() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.LocationFailure
message() - Method in interface io.gdcc.spi.core.loader.LoaderProblem
message() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.MissingServiceProviderRecord
message() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMismatch
message() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMissing
message() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassMismatch
message() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassNameCollision
message() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassNameCollisionWithCore
message() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassUnsupported
message() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderApiLevelMismatch
message() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderClassUnsupported
message() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.SourceFailure
MissingServiceProviderRecord(String, String, Path) - Constructor for record class io.gdcc.spi.core.loader.LoaderProblem.MissingServiceProviderRecord: Creates an instance of a MissingServiceProviderRecord record class.

N

normalizedIdentity() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.DuplicateIdentity: Returns the value of the normalizedIdentity record component.
normalizedIdentity() - Method in record class io.gdcc.spi.meta.descriptor.PluginDescriptor: Returns the normalized identity string of this plugin.

O

of(int, int) - Static method in class io.gdcc.spi.export.PageRequest: Creates a page request with the given offset and limit.
ONLY_PUBLIC_FILES - Enum constant in enum class io.gdcc.spi.export.FileMetadataPredicates: Only include files with public visibility.
ONLY_TABULAR_FILES - Enum constant in enum class io.gdcc.spi.export.FileMetadataPredicates: Only include tabular data files.

P

PageRequest - Class in io.gdcc.spi.export: Defines pagination parameters for data retrieval methods that return potentially large collections of results.
plugin() - Method in record class io.gdcc.spi.core.loader.PluginHandle: Returns the value of the plugin record component.
plugin() - Method in record class io.gdcc.spi.meta.descriptor.SourcedDescriptor: Returns the value of the plugin record component.
Plugin - Interface in io.gdcc.spi.meta.plugin: Represents the contract for plugins in the system.
PLUGIN_CLASS_FIELD - Static variable in class io.gdcc.spi.meta.descriptor.DescriptorFormat
PLUGIN_CONTRACT_ANNOTATION - Static variable in class io.gdcc.spi.meta.processor.ProcessorConstants: Fully qualified name of the contract annotation found on plugin contract interfaces.
PLUGIN_IMPLEMENTATION_ANNOTATION - Static variable in class io.gdcc.spi.meta.processor.ProcessorConstants: Fully qualified name of the implementation marker annotation.
PLUGIN_INTERFACE - Static variable in class io.gdcc.spi.meta.processor.ProcessorConstants: Fully qualified name of the common plugin super-interface.
PLUGIN_KIND_FIELD - Static variable in class io.gdcc.spi.meta.descriptor.DescriptorFormat
pluginClass() - Method in record class io.gdcc.spi.meta.descriptor.PluginDescriptor: Returns the value of the pluginClass record component.
PluginClassApiLevelMismatch(String, Path, int, int) - Constructor for record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMismatch: Creates an instance of a PluginClassApiLevelMismatch record class.
PluginClassApiLevelMissing(String, Path, String, int) - Constructor for record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMissing: Creates an instance of a PluginClassApiLevelMissing record class.
PluginClassMismatch(String, Path, String) - Constructor for record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassMismatch: Creates an instance of a PluginClassMismatch record class.
PluginClassNameCollision(String, Path, Path) - Constructor for record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassNameCollision: Creates an instance of a PluginClassNameCollision record class.
PluginClassNameCollisionWithCore(String, Path) - Constructor for record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassNameCollisionWithCore: Creates an instance of a PluginClassNameCollisionWithCore record class.
PluginClassUnsupported(String, Path, String) - Constructor for record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassUnsupported: Creates an instance of a PluginClassUnsupported record class.
pluginContract() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassUnsupported: Returns the value of the pluginContract record component.
PluginContract - Annotation Interface in io.gdcc.spi.meta.annotations: Declares a versioned plugin contract interface.
PluginContract.Role - Enum Class in io.gdcc.spi.meta.annotations: Distinguishes directly loadable base contracts from additional capability contracts.
PluginContractProcessor - Class in io.gdcc.spi.meta.processor: Annotation processor generating build-time metadata for plugin implementations.
PluginContractProcessor() - Constructor for class io.gdcc.spi.meta.processor.PluginContractProcessor
PluginDescriptor<T extends Plugin> - Record Class in io.gdcc.spi.meta.descriptor: Runtime-facing descriptor of a resolved and loaded plugin implementation.
PluginDescriptor(Path, String, Class<? extends T>, Class<T>, Map<Class<? extends Plugin>, Integer>, Map<Class<? extends CoreProvider>, Integer>) - Constructor for record class io.gdcc.spi.meta.descriptor.PluginDescriptor: Creates an instance of a PluginDescriptor record class.
PluginHandle<T extends Plugin> - Record Class in io.gdcc.spi.core.loader: Encapsulates a plugin and its corresponding descriptor, providing a unified representation of a resolved plugin and its metadata in the runtime context.
PluginHandle(PluginDescriptor<T>, T) - Constructor for record class io.gdcc.spi.core.loader.PluginHandle: Creates an instance of a PluginHandle record class.
pluginKind() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassMismatch: Returns the value of the pluginKind record component.
pluginLevel() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMismatch: Returns the value of the pluginLevel record component.
pluginLevel() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderApiLevelMismatch: Returns the value of the pluginLevel record component.
PluginLoader<T extends Plugin> - Class in io.gdcc.spi.core.loader: Loads plugins of a specified type from JAR files in a given directory using the Java ServiceLoader mechanism.
PluginLoader(Class<T>) - Constructor for class io.gdcc.spi.core.loader.PluginLoader: Constructs a new PluginLoader that will load plugins of the specified type T.
PluginLoader(Class<T>, LoaderConfiguration) - Constructor for class io.gdcc.spi.core.loader.PluginLoader: Constructs a new PluginLoader that will load plugins of the specified type T.
PluginLoader(Class<T>, LoaderConfiguration, ClassLoader) - Constructor for class io.gdcc.spi.core.loader.PluginLoader: Constructs a new instance of the PluginLoader, which is responsible for loading plugins of the specified type T.
PluginLoader(Class<T>, ClassLoader) - Constructor for class io.gdcc.spi.core.loader.PluginLoader: Constructs a new PluginLoader that will load plugins of the specified type T.
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class io.gdcc.spi.meta.processor.PluginContractProcessor: Main processor entry point for each annotation processing round.
ProcessorConstants - Class in io.gdcc.spi.meta.processor
provider() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderApiLevelMismatch: Returns the value of the provider record component.
provider() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderClassUnsupported: Returns the value of the provider record component.
ProviderApiLevelMismatch(String, Path, String, int, int) - Constructor for record class io.gdcc.spi.core.loader.LoaderProblem.ProviderApiLevelMismatch: Creates an instance of a ProviderApiLevelMismatch record class.
ProviderClassUnsupported(String, Path, String) - Constructor for record class io.gdcc.spi.core.loader.LoaderProblem.ProviderClassUnsupported: Creates an instance of a ProviderClassUnsupported record class.
providers() - Element in annotation interface io.gdcc.spi.meta.annotations.PluginContract: Core provider contracts required by this plugin contract.

R

read(Reader) - Static method in class io.gdcc.spi.meta.descriptor.DescriptorFormat: Reads a plugin plugin from the serialized properties format.
read(String) - Static method in class io.gdcc.spi.meta.descriptor.DescriptorFormat: Reads a plugin plugin from the given string content.
REQUIRED_PROVIDER_ANNOTATION - Static variable in class io.gdcc.spi.meta.processor.ProcessorConstants: Fully qualified name of the nested provider requirement annotation used inside @PluginContract.providers().
REQUIRED_PROVIDER_PREFIX - Static variable in class io.gdcc.spi.meta.descriptor.DescriptorFormat
REQUIRED_PROVIDER_SUFFIX - Static variable in class io.gdcc.spi.meta.descriptor.DescriptorFormat
RequiredProvider - Annotation Interface in io.gdcc.spi.meta.annotations: Declares that a PluginContract requires a specific core provider contract.
requiredProviderLevel(Class<?>) - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Returns the declared required API level for the given provider, if present.
requiredProviderLevel(Class<? extends CoreProvider>) - Method in record class io.gdcc.spi.meta.descriptor.PluginDescriptor
requiredProviderLevel(String) - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Returns the declared required API level for the given provider, if present.
requiredProviders() - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Returns the value of the requiredProviders record component.
requiredProviders() - Method in record class io.gdcc.spi.meta.descriptor.PluginDescriptor: Returns the value of the requiredProviders record component.
requires() - Element in annotation interface io.gdcc.spi.meta.annotations.PluginContract: Other plugin contracts that must also be implemented when this contract is implemented.
requiresProvider(Class<?>) - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Checks whether this plugin declares the given required provider.
requiresProvider(Class<? extends CoreProvider>) - Method in record class io.gdcc.spi.meta.descriptor.PluginDescriptor
requiresProvider(String) - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Checks whether this plugin declares the given required provider.
role() - Element in annotation interface io.gdcc.spi.meta.annotations.PluginContract: Declares whether this contract is a directly loadable base contract or an additional capability contract.

S

scanPath(Path) - Static method in class io.gdcc.spi.meta.descriptor.DescriptorScanner: Scans the specified path to identify plugin descriptors.
SKIP_FILES - Enum constant in enum class io.gdcc.spi.export.FileMetadataPredicates: Excludes metadata for all files.
source() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.DuplicateIdentity: Returns the value of the source record component.
source() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.MissingServiceProviderRecord: Returns the value of the source record component.
source() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMismatch: Returns the value of the source record component.
source() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMissing: Returns the value of the source record component.
source() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassMismatch: Returns the value of the source record component.
source() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassNameCollisionWithCore: Returns the value of the source record component.
source() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassUnsupported: Returns the value of the source record component.
source() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderApiLevelMismatch: Returns the value of the source record component.
source() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderClassUnsupported: Returns the value of the source record component.
source1() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassNameCollision: Returns the value of the source1 record component.
source2() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassNameCollision: Returns the value of the source2 record component.
SourcedDescriptor - Record Class in io.gdcc.spi.meta.descriptor: A record representing a descriptor that is sourced from a specific location.
SourcedDescriptor(Path, Descriptor) - Constructor for record class io.gdcc.spi.meta.descriptor.SourcedDescriptor: Creates an instance of a SourcedDescriptor record class.
SourceFailure(Throwable) - Constructor for record class io.gdcc.spi.core.loader.LoaderProblem.SourceFailure: Creates an instance of a SourceFailure record class.
sourceLocation() - Method in record class io.gdcc.spi.meta.descriptor.PluginDescriptor: Returns the value of the sourceLocation record component.
sourceLocation() - Method in record class io.gdcc.spi.meta.descriptor.SourcedDescriptor: Returns the value of the sourceLocation record component.

T

toContractLevel(Class<?>) - Static method in class io.gdcc.spi.meta.descriptor.DescriptorFormat
toContractLevel(String) - Static method in class io.gdcc.spi.meta.descriptor.DescriptorFormat
toFilename(Class<?>) - Static method in class io.gdcc.spi.meta.descriptor.DescriptorFormat
toFilename(String) - Static method in class io.gdcc.spi.meta.descriptor.DescriptorFormat
toPath(Class<?>) - Static method in class io.gdcc.spi.meta.descriptor.DescriptorFormat
toPath(String) - Static method in class io.gdcc.spi.meta.descriptor.DescriptorFormat
toRequiredProviderLevel(Class<?>) - Static method in class io.gdcc.spi.meta.descriptor.DescriptorFormat
toRequiredProviderLevel(String) - Static method in class io.gdcc.spi.meta.descriptor.DescriptorFormat
toString() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.DuplicateIdentity: Returns a string representation of this record class.
toString() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.LocationFailure: Returns a string representation of this record class.
toString() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.MissingServiceProviderRecord: Returns a string representation of this record class.
toString() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMismatch: Returns a string representation of this record class.
toString() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassApiLevelMissing: Returns a string representation of this record class.
toString() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassMismatch: Returns a string representation of this record class.
toString() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassNameCollision: Returns a string representation of this record class.
toString() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassNameCollisionWithCore: Returns a string representation of this record class.
toString() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.PluginClassUnsupported: Returns a string representation of this record class.
toString() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderApiLevelMismatch: Returns a string representation of this record class.
toString() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.ProviderClassUnsupported: Returns a string representation of this record class.
toString() - Method in record class io.gdcc.spi.core.loader.LoaderProblem.SourceFailure: Returns a string representation of this record class.
toString() - Method in record class io.gdcc.spi.core.loader.PluginHandle: Returns a string representation of this record class.
toString() - Method in class io.gdcc.spi.export.DatasetExportQuery
toString() - Method in class io.gdcc.spi.export.FileExportQuery
toString() - Method in class io.gdcc.spi.export.PageRequest
toString() - Method in record class io.gdcc.spi.meta.descriptor.Descriptor: Returns a string representation of this record class.
toString() - Method in record class io.gdcc.spi.meta.descriptor.PluginDescriptor: Returns a string representation of this record class.
toString() - Method in record class io.gdcc.spi.meta.descriptor.SourcedDescriptor: Returns a string representation of this record class.
transformClassName(Class<?>) - Static method in class io.gdcc.spi.meta.descriptor.DescriptorFormat: Transforms the provided class into its canonical name representation.

U

unpaged() - Static method in class io.gdcc.spi.export.PageRequest: Returns a request for all results (no pagination).

V

value() - Element in annotation interface io.gdcc.spi.meta.annotations.RequiredProvider
valueOf(String) - Static method in enum class io.gdcc.spi.export.DatasetMetadataPredicates: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.gdcc.spi.export.FileMetadataPredicates: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.gdcc.spi.meta.annotations.PluginContract.Role: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.gdcc.spi.export.DatasetMetadataPredicates: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.gdcc.spi.export.FileMetadataPredicates: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.gdcc.spi.meta.annotations.PluginContract.Role: Returns an array containing the constants of this enum class, in the order they are declared.

W

withAbortOnCompatibilityProblems(boolean) - Method in class io.gdcc.spi.core.loader.LoaderConfiguration: Returns a copy with LoaderConfiguration.abortOnCompatibilityProblems() updated.
withAbortOnDuplicatedIdentities(boolean) - Method in class io.gdcc.spi.core.loader.LoaderConfiguration: Returns a copy with LoaderConfiguration.abortOnDuplicatedIdentities() updated.
withEmitWarningsOnMultiPluginSource(boolean) - Method in class io.gdcc.spi.core.loader.LoaderConfiguration: Returns a copy with LoaderConfiguration.emitWarningsOnMultiPluginSource() updated.
withEnforceSingleSourceMatchingPluginsOnly(boolean) - Method in class io.gdcc.spi.core.loader.LoaderConfiguration: Returns a copy with LoaderConfiguration.enforceSingleSourceMatchingPluginsOnly() updated.
withEnforceUnambiguousPluginIdentities(boolean) - Method in class io.gdcc.spi.core.loader.LoaderConfiguration: Returns a copy with LoaderConfiguration.enforceUnambiguousPluginIdentities() updated.
write(Descriptor, Writer) - Static method in class io.gdcc.spi.meta.descriptor.DescriptorFormat: Serializes the provided Descriptor into the given Writer in the form of a properties file, encoding plugin metadata such as plugin class, plugin kind, implemented contracts, and required providers.

X

XMLExporter - Interface in io.gdcc.spi.export: XML Exporter is an extension of the base Exporter interface that adds the additional methods needed for generating XML metadata export formats.

A B C D E F G H I K L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form