Index (VirtualDataSet API)

A C D E F G I L M N O P R S T U V
All Classes All Packages

A

addCategories(Category[]) - Method in class io.virtdata.autodoctypes.DocForFunc
addCtor(String, LinkedHashMap<String, String>, List<List<String>>) - Method in class io.virtdata.autodoctypes.DocForFunc
AUTOSUFFIX - Static variable in class io.virtdata.processors.FunctionDocInfoProcessor

C

Categories - Annotation Type in io.virtdata.annotations: Direct the user to additional resources
Category - Enum in io.virtdata.annotations
className - Variable in class io.virtdata.services.FunctionFinderService.Path
collections - io.virtdata.annotations.Category
conversion - io.virtdata.annotations.Category
CTOR_PATTERN - Static variable in class io.virtdata.annotations.ExampleData

D

DATAPATH - Static variable in interface io.virtdata.services.ModuleDataService: When a JPMS module is searched for resources, they must be in within this directory in the module.
datetime - io.virtdata.annotations.Category
DefaultModuleDataService - Class in io.virtdata.services: This class needs to be held in the module for which it will return data, so that local data sources within that module can be resolve relative to the service endpoint itself.
DefaultModuleDataService() - Constructor for class io.virtdata.services.DefaultModuleDataService
DEPRECATED_PATH - Static variable in interface io.virtdata.services.ModuleDataService: Deprecated.
This will no longer be used as a default search path within modules
DeprecatedFunction - Annotation Type in io.virtdata.annotations: This marks functions as deprecated, with a reason.
Description - Annotation Type in io.virtdata.annotations
diagnostics - io.virtdata.annotations.Category
distributions - io.virtdata.annotations.Category
DocCtorData - Interface in io.virtdata.autodoctypes
DocForFunc - Class in io.virtdata.autodoctypes
DocForFunc() - Constructor for class io.virtdata.autodoctypes.DocForFunc
DocForFuncCtor - Class in io.virtdata.autodoctypes
DocForFuncCtor(String, String, Map<String, String>, List<List<String>>) - Constructor for class io.virtdata.autodoctypes.DocForFuncCtor
DocFuncData - Interface in io.virtdata.autodoctypes: Provide data about a function, suitable for building a documentation site.
Doubles - io.virtdata.annotations.Range
DoubleUnitInterval - io.virtdata.annotations.Range

E

Example - Annotation Type in io.virtdata.annotations: The example annotation allows for a function developer to attach illustrative examples for any given constructor.
ExampleData - Class in io.virtdata.annotations: Formatting conventions
ExampleData(String[]) - Constructor for class io.virtdata.annotations.ExampleData
ExampleDocData - Class in io.virtdata.autodoctypes
ExampleDocData() - Constructor for class io.virtdata.autodoctypes.ExampleDocData
ExampleManifest - Class in io.virtdata.autodoctypes
ExampleManifest() - Constructor for class io.virtdata.autodoctypes.ExampleManifest
Examples - Annotation Type in io.virtdata.annotations

F

finder - Variable in class io.virtdata.services.FunctionFinderService.Path
FloatUnitInterval - io.virtdata.annotations.Range
FunctionDocInfoProcessor - Class in io.virtdata.processors: This documentation processor is responsible for finding all the enumerated that feed documentation manifests.
FunctionDocInfoProcessor() - Constructor for class io.virtdata.processors.FunctionDocInfoProcessor
FunctionFinderService - Interface in io.virtdata.services: This module is based on JPMS modules.
FunctionFinderService.Path - Class in io.virtdata.services
FUNCTIONS_FILE - Static variable in class io.virtdata.processors.FunctionDocInfoProcessor
FUNCTIONS_FILE - Static variable in interface io.virtdata.services.FunctionFinderService

G

general - io.virtdata.annotations.Category
getArgs() - Method in interface io.virtdata.autodoctypes.DocCtorData
getArgs() - Method in class io.virtdata.autodoctypes.DocForFuncCtor
getCategories() - Method in class io.virtdata.autodoctypes.DocForFunc
getCategories() - Method in interface io.virtdata.autodoctypes.DocFuncData
getCategories() - Method in class io.virtdata.autodoctypes.ExampleDocData
getClassJavadoc() - Method in class io.virtdata.autodoctypes.DocForFunc
getClassJavadoc() - Method in interface io.virtdata.autodoctypes.DocFuncData: Javadoc for the class, or null if there is none.
getClassJavadoc() - Method in class io.virtdata.autodoctypes.ExampleDocData
getClassName() - Method in interface io.virtdata.autodoctypes.DocCtorData
getClassName() - Method in class io.virtdata.autodoctypes.DocForFunc
getClassName() - Method in class io.virtdata.autodoctypes.DocForFuncCtor
getClassName() - Method in interface io.virtdata.autodoctypes.DocFuncData
getClassName() - Method in class io.virtdata.autodoctypes.ExampleDocData
getCtorJavaDoc() - Method in interface io.virtdata.autodoctypes.DocCtorData
getCtorJavaDoc() - Method in class io.virtdata.autodoctypes.DocForFuncCtor
getCtors() - Method in class io.virtdata.autodoctypes.DocForFunc
getCtors() - Method in interface io.virtdata.autodoctypes.DocFuncData: The list of constructors for this documented type.
getCtors() - Method in class io.virtdata.autodoctypes.ExampleDocData
getCtorsAlternate() - Method in class io.virtdata.autodoctypes.ExampleDocData
getDescription() - Method in enum io.virtdata.annotations.Range
getDocs() - Method in class io.virtdata.autodoctypes.ExampleManifest
getExamples() - Method in interface io.virtdata.autodoctypes.DocCtorData
getExamples() - Method in class io.virtdata.autodoctypes.DocForFuncCtor
getFuncDataForModule() - Method in interface io.virtdata.services.FunctionFinderService: Return a list of information models which describe a usable VirtData function.
getFuncDataForModule() - Method in class io.virtdata.services.ModuleFunctionFinder
getFunctionPaths() - Method in interface io.virtdata.services.FunctionFinderService: Return a list of known functions by module and fully-qualified package name.
getFunctionPaths() - Method in class io.virtdata.services.ModuleFunctionFinder
getInputStream(Path, Path...) - Method in class io.virtdata.services.DefaultModuleDataService
getInputStream(Path, Path...) - Method in interface io.virtdata.services.ModuleDataService
getInType() - Method in class io.virtdata.autodoctypes.DocForFunc
getInType() - Method in interface io.virtdata.autodoctypes.DocFuncData: The input type for the apply method in the documented function class.
getInType() - Method in class io.virtdata.autodoctypes.ExampleDocData
getLongInputs() - Method in class io.virtdata.annotations.ExampleData
getModuleOfFinder() - Method in class io.virtdata.services.ModuleFunctionFinder
getOutType() - Method in class io.virtdata.autodoctypes.DocForFunc
getOutType() - Method in interface io.virtdata.autodoctypes.DocFuncData: The output type for the apply method in the documented function class.
getOutType() - Method in class io.virtdata.autodoctypes.ExampleDocData
getPackageName() - Method in class io.virtdata.autodoctypes.DocForFunc
getPackageName() - Method in interface io.virtdata.autodoctypes.DocFuncData
getPackageName() - Method in class io.virtdata.autodoctypes.ExampleDocData

I

init(ProcessingEnvironment) - Method in class io.virtdata.processors.FunctionDocInfoProcessor
init(ProcessingEnvironment) - Method in class io.virtdata.processors.ServiceProcessor
Input - Annotation Type in io.virtdata.annotations: This annotation is used to mark the input type for a functional interface which uses generics, like LongFunction, IntFunction, or Function.
instantiateDocs() - Method in class io.virtdata.services.FunctionFinderService.Path
Integers - io.virtdata.annotations.Range
io.virtdata.annotations - module io.virtdata.annotations
io.virtdata.annotations - package io.virtdata.annotations
io.virtdata.autodoctypes - package io.virtdata.autodoctypes
io.virtdata.processors - package io.virtdata.processors
io.virtdata.services - package io.virtdata.services

L

Longs - io.virtdata.annotations.Range

M

ModuleDataService - Interface in io.virtdata.services
ModuleFunctionFinder - Class in io.virtdata.services
ModuleFunctionFinder() - Constructor for class io.virtdata.services.ModuleFunctionFinder
moduleName - Variable in class io.virtdata.services.FunctionFinderService.Path

N

name() - Method in annotation type io.virtdata.annotations.See
NonNegativeInts - io.virtdata.annotations.Range
NonNegativeLongs - io.virtdata.annotations.Range

O

Output - Annotation Type in io.virtdata.annotations: This annotation is used to mark the output type for a functional interface which uses generics, like LongFunction, IntFunction, or Function.

P

parts - Variable in class io.virtdata.annotations.ExampleData
Path(String, String, FunctionFinderService) - Constructor for class io.virtdata.services.FunctionFinderService.Path
PerThreadMapper - Annotation Type in io.virtdata.annotations: A PerThreadMapper will be instantiated once for each thread, for each scope in which it is used.
premade - io.virtdata.annotations.Category
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class io.virtdata.processors.FunctionDocInfoProcessor
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class io.virtdata.processors.ServiceProcessor

R

Range - Enum in io.virtdata.annotations

S

See - Annotation Type in io.virtdata.annotations: Direct the user to additional resources
SeeList - Annotation Type in io.virtdata.annotations: Direct the user to additional resources
Service - Annotation Type in io.virtdata.annotations: A Service annotation will cause a class to be added to META-INF/services/ under the specified class name.
ServiceProcessor - Class in io.virtdata.processors: This annotation processor is responsible for adding services to the
ServiceProcessor() - Constructor for class io.virtdata.processors.ServiceProcessor
setClassJavadoc(String) - Method in class io.virtdata.autodoctypes.DocForFunc
setClassName(String) - Method in class io.virtdata.autodoctypes.DocForFunc
setInType(String) - Method in class io.virtdata.autodoctypes.DocForFunc
setOutType(String) - Method in class io.virtdata.autodoctypes.DocForFunc
setPackageName(String) - Method in class io.virtdata.autodoctypes.DocForFunc
state - io.virtdata.annotations.Category

T

ThreadSafeMapper - Annotation Type in io.virtdata.annotations: A ThreadSafeMapper will only be instantiated once in a scope, to be shared among all threads in that scope.
toString() - Method in class io.virtdata.autodoctypes.DocForFunc
toString() - Method in class io.virtdata.autodoctypes.DocForFuncCtor
toString() - Method in class io.virtdata.services.DefaultModuleDataService
toString() - Method in class io.virtdata.services.FunctionFinderService.Path
toString() - Method in class io.virtdata.services.ModuleFunctionFinder

U

url() - Method in annotation type io.virtdata.annotations.See

V

validateExamples(List<List<String>>) - Static method in class io.virtdata.annotations.ExampleData
VALS_PATTERN - Static variable in class io.virtdata.annotations.ExampleData
value() - Method in annotation type io.virtdata.annotations.Categories
value() - Method in annotation type io.virtdata.annotations.DeprecatedFunction
value() - Method in annotation type io.virtdata.annotations.Description
value() - Method in annotation type io.virtdata.annotations.Example
value() - Method in annotation type io.virtdata.annotations.Examples
value() - Method in annotation type io.virtdata.annotations.Input
value() - Method in annotation type io.virtdata.annotations.Output
value() - Method in annotation type io.virtdata.annotations.SeeList
value() - Method in annotation type io.virtdata.annotations.Service
valueOf(String) - Static method in enum io.virtdata.annotations.Category: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.virtdata.annotations.Range: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.virtdata.annotations.Category: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.virtdata.annotations.Range: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G I L M N O P R S T U V
All Classes All Packages