AbstractSchemaProvider

All Implemented Interfaces:: net.corda.schema.common.provider.SchemaProvider


public abstract class AbstractSchemaProvider
 implements SchemaProvider

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract String`	`getResourceRoot()`
`InputStream`	`getSchema(@NotNull() String key, @NotNull() Version version)`	Retrieve the schema file for a top-level configuration key.
`InputStream`	`getSchemaFile(@NotNull() String fileName)`	Retrieve a schema file with the given path.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - getResourceRoot
```
 abstract String getResourceRoot()
```
  - getSchema
```
@NotNull() InputStream getSchema(@NotNull() String key, @NotNull() Version version)
```
    Retrieve the schema file for a top-level configuration key.
    Note that this does not resolve $ref fields in the schema file. However, these references should point to another file contained in this module, which can then be retrieved with getSchemaFile.
    
    Parameters:
    
    key - The top-level configuration key to retrieve schema for.
  - getSchemaFile
```
@NotNull() InputStream getSchemaFile(@NotNull() String fileName)
```
    Retrieve a schema file with the given path.
    This can be used to retrieve files required to resolve $ref fields in the schema.
    
    Parameters:
    
    fileName - The file to retrieve.