Package org.brapi.schematools.core.graphql.metadata

Class GraphQLGeneratorMetadata

java.lang.Object

org.brapi.schematools.core.graphql.metadata.GraphQLGeneratorMetadata

All Implemented Interfaces:

Metadata, Validatable

public class GraphQLGeneratorMetadata
extends Object
implements Metadata

Provides metadata for the GraphQL generation

Constructor Summary

Constructors

Constructor	Description
GraphQLGeneratorMetadata()

Method Summary

Modifier and Type	Method	Description
static GraphQLGeneratorMetadata	load()	Load the default metadata
static GraphQLGeneratorMetadata	load(InputStream inputStream)	Load the metadata from an metadata input stream in YAML or Json.
static GraphQLGeneratorMetadata	load(Path metadataFile)	Load the metadata from a metadata file in YAML or Json.
GraphQLGeneratorMetadata	override(GraphQLGeneratorMetadata overrideMetadata)	Overrides the values in this Options Object from the provided Options Object if they are non-null

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.brapi.schematools.core.validiation.Validatable

validate

Constructor Details

GraphQLGeneratorMetadata

public GraphQLGeneratorMetadata()

Method Details

load

public static GraphQLGeneratorMetadata load()

Load the default metadata

Returns:

The default metadata

load

public static GraphQLGeneratorMetadata load(Path metadataFile)
                                     throws IOException

Load the metadata from a metadata file in YAML or Json. The metadata file may have missing (defined) values, in these cases the default values are loaded. See load()

Parameters:

metadataFile - The path to the metadata file in YAML or Json.

Returns:

The metadata loaded from the YAML or Json file.

Throws:

IOException - if the metadata file can not be found or is incorrectly formatted.

load

public static GraphQLGeneratorMetadata load(InputStream inputStream)
                                     throws IOException

Load the metadata from an metadata input stream in YAML or Json. The metadata file may have missing (defined) values, in these cases the default values are loaded. See load()

Parameters:

inputStream - The input stream in YAML or Json.

Returns:

The metadata loaded from input stream.

Throws:

IOException - if the input stream is not valid or the content is incorrectly formatted.

override

public GraphQLGeneratorMetadata override(GraphQLGeneratorMetadata overrideMetadata)

Overrides the values in this Options Object from the provided Options Object if they are non-null

Parameters:

overrideMetadata - the options which will be used to override this Options Object

Returns:

this options for method chaining