public interface ApiProvider
ApiProviderFactory
.Modifier and Type | Method and Description |
---|---|
Api |
create()
Create a new API.
|
java.lang.String |
getDescription()
Get a description of this API provider.
|
java.lang.String |
getID()
Get the ID of this API provider.
|
java.lang.String |
getName()
Get the name of this API provider.
|
Api |
load(java.io.InputStream is,
java.lang.String fileName,
Resolver resolver)
Load an API from the specified input stream, using the specified resolver to
find any other files that are required to load this API.
|
Api |
load(java.nio.file.Path file)
Load an API from the specified file.
|
Api |
load(java.nio.file.Path file,
Resolver resolver)
Load an API from the specified file, using the specified resolver to find
any other files that are required to load this API.
|
Api |
load(java.net.URI uri)
Load an API from the specified URI.
|
Api |
loadFromZip(java.util.zip.ZipInputStream zis,
java.lang.String fileName)
Load an API from the specified file, which should be loaded from the specified
ZIP input stream.
|
java.lang.String getID()
java.lang.String getName()
java.lang.String getDescription()
Api load(java.net.URI uri) throws ApiException
uri
- the URI of the API to load.ApiException
- if an error occurs loading the API.Api load(java.nio.file.Path file) throws ApiException
file
- the file to load the API from.ApiException
- if an error occurs loading the API.Api load(java.nio.file.Path file, Resolver resolver) throws ApiException
file
- the file to load the API from.resolver
- the resolver to use to find any other required files.ApiException
- if an error occurs loading the API.Api load(java.io.InputStream is, java.lang.String fileName, Resolver resolver) throws ApiException
is
- the input stream to load the API from.fileName
- the file name that represents this input stream.resolver
- the resolver to use to find any other required files.ApiException
- if an error occurs loading the API.Api loadFromZip(java.util.zip.ZipInputStream zis, java.lang.String fileName) throws ApiException
zis
- the ZIP input stream to load the API from.fileName
- the file to load the API from.ApiException
- if an error occurs loading the API.Api create() throws ApiException
ApiException
- if an error occurs creating the new API.