Index (core 0.34.0 API)

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

A

AbstractGeneratorOptions - Class in org.brapi.schematools.core.options: Abstract class for all Generator Options
AbstractGeneratorOptions() - Constructor for class org.brapi.schematools.core.options.AbstractGeneratorOptions
AbstractGeneratorSubOptions - Class in org.brapi.schematools.core.options: Provides general options for all sub-options in generators
AbstractGeneratorSubOptions() - Constructor for class org.brapi.schematools.core.options.AbstractGeneratorSubOptions
AbstractGraphQLOptions - Class in org.brapi.schematools.core.graphql.options: Provides general options for the generation of Endpoints
AbstractGraphQLOptions() - Constructor for class org.brapi.schematools.core.graphql.options.AbstractGraphQLOptions
AbstractGraphQLQueryOptions - Class in org.brapi.schematools.core.graphql.options: Abstract base class for all GraphQL Options
AbstractGraphQLQueryOptions() - Constructor for class org.brapi.schematools.core.graphql.options.AbstractGraphQLQueryOptions
AbstractOpenAPIMetadata - Class in org.brapi.schematools.core.openapi.generator.metadata: Base class for OpenAPI metadata
AbstractOpenAPIMetadata() - Constructor for class org.brapi.schematools.core.openapi.generator.metadata.AbstractOpenAPIMetadata
AbstractOpenAPIOptions - Class in org.brapi.schematools.core.openapi.generator.options: Provides general options for the generation of Endpoints
AbstractOpenAPIOptions() - Constructor for class org.brapi.schematools.core.openapi.generator.options.AbstractOpenAPIOptions
addError(Response.ErrorType, String, String) - Method in class org.brapi.schematools.core.response.Response: Adds an error to the response.
addError(Response.ErrorType, Response.Error) - Method in class org.brapi.schematools.core.response.Response: Adds an error to the response.
ASCIIDOC - Enum constant in enum class org.brapi.schematools.core.openapi.comparator.ComparisonOutputFormat: Use this to render the comparison output in Asciidoc format
AsciiDocRenderOptions - Class in org.brapi.schematools.core.openapi.comparator.options: AsciiDoc Render Options for the OpenAPIComparator.
AsciiDocRenderOptions() - Constructor for class org.brapi.schematools.core.openapi.comparator.options.AsciiDocRenderOptions
asResponse() - Method in class org.brapi.schematools.core.validiation.Validation: Returns this Validation as a Response
assertClass(Object, List<Class<?>>) - Method in class org.brapi.schematools.core.validiation.Validation: Checks that the provided value is one of the provided classes
assertMutuallyExclusive(Object, String...) - Method in class org.brapi.schematools.core.validiation.Validation: Validate that only one of the provided properties is non-null
assertNotNull(Object, String, Object...) - Method in class org.brapi.schematools.core.validiation.Validation: Checks if the value is non-null.

B

BOOLEAN - Static variable in class org.brapi.schematools.core.model.BrAPIPrimitiveType: Boolean Primitive Type
BRAPI_COMMON - Static variable in class org.brapi.schematools.core.openapi.generator.OpenAPIGenerator
BrAPIAllOfType - Class in org.brapi.schematools.core.model: Represents a type that takes all of properties from the wrapped types
BrAPIAllOfType() - Constructor for class org.brapi.schematools.core.model.BrAPIAllOfType
BrAPIArrayType - Class in org.brapi.schematools.core.model: Array type that represents an array of items of type BrAPIArrayType.items.
BrAPIArrayType() - Constructor for class org.brapi.schematools.core.model.BrAPIArrayType
BrAPIClass - Interface in org.brapi.schematools.core.model: Interface implemented by types that are output data modules, but are not simple scalar types or an array
BrAPIClassCacheUtil - Class in org.brapi.schematools.core.utils: Utility class for creating a cache of BrAPIClasses.
BrAPIClassCacheUtil() - Constructor for class org.brapi.schematools.core.utils.BrAPIClassCacheUtil
BrAPIEnumType - Class in org.brapi.schematools.core.model: A BrAPI Class that provides a list of possible BrAPIEnumType.values of a specific BrAPIEnumType.type.
BrAPIEnumType() - Constructor for class org.brapi.schematools.core.model.BrAPIEnumType
BrAPIEnumValue - Class in org.brapi.schematools.core.model: A value within an enumeration list
BrAPIEnumValue() - Constructor for class org.brapi.schematools.core.model.BrAPIEnumValue
BrAPIMetadata - Class in org.brapi.schematools.core.model: The BrAPI metadata associated with a BrAPIClass.
BrAPIMetadata() - Constructor for class org.brapi.schematools.core.model.BrAPIMetadata
BrAPIObjectProperty - Class in org.brapi.schematools.core.model: The property definition for a BrAPI Object.
BrAPIObjectProperty() - Constructor for class org.brapi.schematools.core.model.BrAPIObjectProperty
BrAPIObjectType - Class in org.brapi.schematools.core.model: An Object definition that has BrAPIObjectType.properties
BrAPIObjectType() - Constructor for class org.brapi.schematools.core.model.BrAPIObjectType
BrAPIOneOfType - Class in org.brapi.schematools.core.model: A BrAPI Class that represents one and only one BrAPIOneOfType.possibleTypes.
BrAPIOneOfType() - Constructor for class org.brapi.schematools.core.model.BrAPIOneOfType
BrAPIPrimitiveType - Class in org.brapi.schematools.core.model: A scalar or primitive type, which can be one of 4 possible instances: BrAPIPrimitiveType.BOOLEAN, BrAPIPrimitiveType.INTEGER, BrAPIPrimitiveType.NUMBER, or BrAPIPrimitiveType.STRING.
BrAPIReferenceType - Class in org.brapi.schematools.core.model: A reference to another named type with BrAPIReferenceType.name.
BrAPIReferenceType() - Constructor for class org.brapi.schematools.core.model.BrAPIReferenceType
BrAPIRelationshipType - Enum Class in org.brapi.schematools.core.model: The type of relationship between types
BrAPISchemaReader - Class in org.brapi.schematools.core.brapischema: Utility class for reading BrAPI JSON Schema.
BrAPISchemaReader() - Constructor for class org.brapi.schematools.core.brapischema.BrAPISchemaReader: Creates schema reader with a basic ObjectMapper and V202012 JSonSchema version
BrAPISchemaReaderException - Exception Class in org.brapi.schematools.core.brapischema: Exception thrown during the reading of BrAPI JSON Schema
BrAPISchemaReaderException(Exception) - Constructor for exception class org.brapi.schematools.core.brapischema.BrAPISchemaReaderException: Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
BrAPISchemaReaderException(String, Exception) - Constructor for exception class org.brapi.schematools.core.brapischema.BrAPISchemaReaderException: Constructs a new exception with the specified detail message and cause.
BrAPIType - Interface in org.brapi.schematools.core.model: Base class for all BrAPI Types
BrAPITypeUtils - Class in org.brapi.schematools.core.utils: Provides utility methods for BrAPI Types
BrAPITypeUtils() - Constructor for class org.brapi.schematools.core.utils.BrAPITypeUtils

C

capitalise(String) - Static method in class org.brapi.schematools.core.utils.StringUtils: Create a capitalised version of a string value, where the first character is converted to upper case
ColumnOption - Class in org.brapi.schematools.core.xlsx.options: Subclass of ValuePropertyOption for Columns
ColumnOption() - Constructor for class org.brapi.schematools.core.xlsx.options.ColumnOption
compare(String, String) - Method in class org.brapi.schematools.core.openapi.comparator.OpenAPIComparator: Compares the OpenAPI Specification in a string on a file path and outputs the result in the provided format and returns a diff object for downstream use.
compare(String, String, Path, ComparisonOutputFormat) - Method in class org.brapi.schematools.core.openapi.comparator.OpenAPIComparator: Compares the OpenAPI Specification in files on a file path and a diff object for downstream use.
compare(Path, Path) - Method in class org.brapi.schematools.core.openapi.comparator.OpenAPIComparator: Compares the OpenAPI Specification in files on a file path and returns a diff object for downstream use.
compare(Path, Path, Path, ComparisonOutputFormat) - Method in class org.brapi.schematools.core.openapi.comparator.OpenAPIComparator: Compares the OpenAPI Specification in files on a file path and outputs the result in the provided format.
ComparisonOutputFormat - Enum Class in org.brapi.schematools.core.openapi.comparator: Enumeration that provides the possible outputs for comparison
conditionalMapResult(boolean, UnaryOperator<T>) - Method in class org.brapi.schematools.core.response.Response: If the condition is true and this response has no errors creates a new Response with the result from the function, otherwise a new Response with the errors from this resource.
conditionalMapResultToResponse(boolean, Function<T, Response<T>>) - Method in class org.brapi.schematools.core.response.Response: If the condition is true and this response has no errors use the function to get the new response
conditionalMapResultToResponse(boolean, Supplier<Response<T>>) - Method in class org.brapi.schematools.core.response.Response: If the condition is true and this response has no errors use the supplier to get the new response
conditionalMapResultToResponse(Predicate<T>, Function<T, Response<T>>) - Method in class org.brapi.schematools.core.response.Response: If the predicate returns true and this response has no errors creates a new Response with the result from the function, otherwise a new Response with the errors from this resource.
conditionalMapResultToResponse(Predicate<T>, Supplier<Response<T>>) - Method in class org.brapi.schematools.core.response.Response: If the predicate returns true and this response has no errors creates a new Response with the result from the function, otherwise a new Response with the errors from this resource.
ConfigurationUtils - Class in org.brapi.schematools.core.utils: Utility class for loading configuration files.
ConfigurationUtils() - Constructor for class org.brapi.schematools.core.utils.ConfigurationUtils
createMap(List<BrAPIClass>) - Method in class org.brapi.schematools.core.utils.BrAPIClassCacheUtil: Creates the cache of classes as a Map
CreateMutationOptions - Class in org.brapi.schematools.core.graphql.options: Provides options for the generation of New Mutations
CreateMutationOptions() - Constructor for class org.brapi.schematools.core.graphql.options.CreateMutationOptions

D

DeleteMetadata - Class in org.brapi.schematools.core.openapi.generator.metadata: Provides metadata for the Delete endpoints
DeleteMetadata() - Constructor for class org.brapi.schematools.core.openapi.generator.metadata.DeleteMetadata
DeleteMutationOptions - Class in org.brapi.schematools.core.graphql.options: Provides options for the generation of Delete Mutations
DeleteMutationOptions() - Constructor for class org.brapi.schematools.core.graphql.options.DeleteMutationOptions
DeleteOptions - Class in org.brapi.schematools.core.openapi.generator.options: Provides options for the generation of Delete Endpoints
DeleteOptions() - Constructor for class org.brapi.schematools.core.openapi.generator.options.DeleteOptions

E

EMBEDDED - Enum constant in enum class org.brapi.schematools.core.graphql.options.LinkType: The json property value will be embedded in the parent object
EMBEDDED - Enum constant in enum class org.brapi.schematools.core.openapi.generator.LinkType: The json property value will be embedded in the parent object
empty() - Static method in class org.brapi.schematools.core.response.Response: Creates an empty response
Error() - Constructor for class org.brapi.schematools.core.response.Response.Error
executeLogging() - Method in interface org.brapi.schematools.core.response.Response.ErrorLogging: Execute the error logging

F

fail(Response.ErrorType, String) - Static method in class org.brapi.schematools.core.response.Response: Creates a failed response
fail(Response.ErrorType, String, String) - Static method in class org.brapi.schematools.core.response.Response: Creates a failed response
fail(Response.ErrorType, Path, String) - Static method in class org.brapi.schematools.core.response.Response: Creates a failed response for the validation of a file path
failWithLogging(Response.ErrorType, String, Response.ErrorLogging) - Static method in class org.brapi.schematools.core.response.Response: Creates a failed response, and executes a logging call back
findByNameOrLabel(String) - Static method in enum class org.brapi.schematools.core.graphql.options.LinkType: Find a LinkType by name or label
findByNameOrLabel(String) - Static method in enum class org.brapi.schematools.core.model.BrAPIRelationshipType: Find the Relationship Type by its name or label, case-insensitive.
findByNameOrLabel(String) - Static method in enum class org.brapi.schematools.core.openapi.generator.LinkType: Find a LinkType by name or label
fromNameOrLabel(String) - Static method in enum class org.brapi.schematools.core.model.BrAPIRelationshipType: Find the Relationship Type by its name or label, case-insensitive.
fromNameOrLabels(String) - Static method in enum class org.brapi.schematools.core.graphql.options.LinkType: Find a LinkType by name or label
fromNameOrLabels(String) - Static method in enum class org.brapi.schematools.core.openapi.generator.LinkType: Find a LinkType by name or label
fromNameOrLabels(List<String>) - Static method in enum class org.brapi.schematools.core.model.BrAPIRelationshipType: Find the Relationship Types by names or labels, case-insensitive.

G

generate(GraphQLSchema) - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGenerator: Generates Markdown files for type definitions and their field descriptions, query definitions and their arguments descriptions from the GraphQL schema
generate(Path) - Method in class org.brapi.schematools.core.graphql.GraphQLGenerator: Generates the GraphQLSchema from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI Json schema and the additional subdirectories called 'Requests' that contains the request schemas and BrAPI-Common that contains common schemas for use across modules.
generate(Path) - Method in class org.brapi.schematools.core.markdown.MarkdownGenerator: Generates Markdown files for type and their field descriptions from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI Json schema and the additional subdirectories called 'Requests' that contains the request schemas and BrAPI-Common that contains common schemas for use across modules.
generate(Path) - Method in class org.brapi.schematools.core.ontmodel.OntModelGenerator: Generates the OntModel from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI Json schema and BrAPI-Common that contains common schemas for use across modules.
generate(Path) - Method in class org.brapi.schematools.core.xlsx.XSSFWorkbookGenerator: Generates Excel (xlsx) file(s) for type and their field descriptions from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI Json schema and the additional subdirectories called 'Requests' that contains the request schemas and BrAPI-Common that contains common schemas for use across modules.
generate(Path, Path) - Method in class org.brapi.schematools.core.openapi.generator.OpenAPIGenerator: Generates a list of OpenAPI from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI JSON schema and the additional subdirectories called 'Requests' that contains the request schemas and BrAPI-Common that contains common schemas for use across modules.
generate(Path, Path, Collection<String>) - Method in class org.brapi.schematools.core.openapi.generator.OpenAPIGenerator: Generates a list of OpenAPI from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI JSON schema and the additional subdirectories called 'Requests' that contains the request schemas and BrAPI-Common that contains common schemas for use across modules.
generate(Path, Path, OpenAPIGeneratorMetadata) - Method in class org.brapi.schematools.core.openapi.generator.OpenAPIGenerator: Generates a list of OpenAPI from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI JSON schema and the additional subdirectories called 'Requests' that contains the request schemas and BrAPI-Common that contains common schemas for use across modules.
generate(Path, Path, OpenAPIGeneratorMetadata, Collection<String>) - Method in class org.brapi.schematools.core.openapi.generator.OpenAPIGenerator: Generates a list of OpenAPI from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI JSON schema and the additional subdirectories called 'Requests' that contains the request schemas and BrAPI-Common that contains common schemas for use across modules.
generate(Path, GraphQLGeneratorMetadata) - Method in class org.brapi.schematools.core.graphql.GraphQLGenerator: Generates the GraphQLSchema from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI Json schema and the additional subdirectories called 'Requests' that contains the request schemas and BrAPI-Common that contains common schemas for use across modules.
generate(Path, OntModelGeneratorMetadata) - Method in class org.brapi.schematools.core.ontmodel.OntModelGenerator: Generates the RDF OntModel from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI Json schema and BrAPI-Common that contains common schemas for use across modules.
generator(Path) - Static method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGenerator: Creates the default Generator.
getAllErrors() - Method in class org.brapi.schematools.core.response.Response: Get the all errors in this response, regardless of type
getAllErrorsMessage() - Method in class org.brapi.schematools.core.validiation.Validation: Gets concatenated a list of all error messages or null if there are no errors.
getCreateMutationNameFor(String) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Gets the name of the Create Mutation of specific primary model
getDeleteMutationNameFor(String) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Gets the name of the Delete Mutation of specific primary model
getDescription() - Method in interface org.brapi.schematools.core.model.BrAPIClass: The class description
getDescriptionFor(String) - Method in class org.brapi.schematools.core.options.AbstractGeneratorSubOptions: Gets the description for a specific primary model
getDescriptionFor(BrAPIType) - Method in class org.brapi.schematools.core.options.AbstractGeneratorSubOptions: Gets the description for a specific primary model
getDescriptionForArgument(GraphQLFieldDefinition, GraphQLArgument) - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Creates the description for a GraphQLArgument
getDescriptionForEnum(GraphQLEnumType) - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Creates the description for a GraphQLEnumType
getDescriptionForField(GraphQLNamedType, GraphQLFieldDefinition) - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Creates the description for a GraphQLFieldDefinition
getDescriptionForInputField(GraphQLInputObjectType, GraphQLFieldDefinition, GraphQLInputObjectField) - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Creates the description for a GraphQLInputObjectField
getDescriptionForInputObjectType(GraphQLInputObjectType, GraphQLFieldDefinition) - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Creates the description for a GraphQLInputObjectType
getDescriptionForInterface(GraphQLInterfaceType) - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Creates the description for a GraphQLInterfaceType
getDescriptionForListQuery(GraphQLFieldDefinition, GraphQLOutputType, GraphQLInputType) - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Creates the query description for a List Query
getDescriptionForObjectType(GraphQLObjectType, GraphQLOutputType, GraphQLFieldDefinition) - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Creates the description for a GraphQLObjectType
getDescriptionForQuery(GraphQLFieldDefinition, GraphQLOutputType, GraphQLInputType) - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Creates the query description for a Query
getDescriptionForSearchQuery(GraphQLFieldDefinition, GraphQLOutputType, GraphQLInputType) - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Creates the query description for a Search Query
getDescriptionOrDefault(String, String) - Method in class org.brapi.schematools.core.openapi.generator.metadata.AbstractOpenAPIMetadata: Gets the description for a specific primary model
getDescriptionOrDefault(BrAPIType, String) - Method in class org.brapi.schematools.core.openapi.generator.metadata.AbstractOpenAPIMetadata: Gets the description for a specific primary model
getErrorMessages() - Method in class org.brapi.schematools.core.validiation.Validation: Gets a list of all error messages or an empty list if there are no errors.
getIdFieldFor(BrAPIObjectProperty) - Method in class org.brapi.schematools.core.graphql.options.IdsOptions: Gets the converted id link property name for a property
getIDFieldFor(String) - Method in class org.brapi.schematools.core.graphql.options.IdsOptions: Gets the id field name for a specific primary model.
getIDFieldFor(BrAPIType) - Method in class org.brapi.schematools.core.graphql.options.IdsOptions: Gets the id field name for a specific primary model.
getIdPropertyFor(BrAPIType) - Method in class org.brapi.schematools.core.options.PropertiesOptions: Gets the id property for a type
getIdPropertyNameFor(String) - Method in class org.brapi.schematools.core.options.PropertiesOptions: Gets the id property name for a type
getIdPropertyNameFor(BrAPIType) - Method in class org.brapi.schematools.core.options.PropertiesOptions: Gets the id property name for a type
getIdsFieldFor(BrAPIObjectProperty) - Method in class org.brapi.schematools.core.graphql.options.IdsOptions: Gets the converted ids link property name for a property
getIdsPropertyNameFor(BrAPIObjectProperty) - Method in class org.brapi.schematools.core.options.PropertiesOptions: Gets the converted ids link property name for a property
getLinkPropertiesFor(BrAPIObjectType) - Method in class org.brapi.schematools.core.options.PropertiesOptions: Gets the list of link properties that are used to generate links to the provided object type.
getLinkTypeFor(BrAPIObjectType, BrAPIObjectProperty) - Method in class org.brapi.schematools.core.graphql.options.PropertiesOptions: Gets the link type for a type property
getLinkTypeFor(BrAPIObjectType, BrAPIObjectProperty) - Method in class org.brapi.schematools.core.options.PropertiesOptions: Gets the link type for a type property
getListQueryNameFor(String) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Gets the name of the List Query of specific primary model
getListResponseNameFor(String) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Gets the name for the List Response for a specific Primary Model
getListResponseNameFor(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Gets the name for the List Response for a specific Primary Model
getMessages() - Method in class org.brapi.schematools.core.response.Response: Gets a list of all the error message for this response
getMessagesCombined(String) - Method in class org.brapi.schematools.core.response.Response: Gets a combined error message for all the error messages for this response, separated with the provided delimiter
getMetadata() - Method in interface org.brapi.schematools.core.model.BrAPIClass: Gets the metadata associated with this class
getModule() - Method in interface org.brapi.schematools.core.model.BrAPIClass: Gets the module to which this class belongs
getName() - Method in interface org.brapi.schematools.core.model.BrAPIType: Gets the name of the BrAPI Type
getNameFor(String) - Method in class org.brapi.schematools.core.graphql.options.AbstractGraphQLOptions: Gets the name of the query or mutation for a specific primary model
getNameFor(String) - Method in class org.brapi.schematools.core.graphql.options.IdsOptions: Gets the name of the id for a specific primary model
getNameFor(String) - Method in class org.brapi.schematools.core.graphql.options.InputOptions: Gets the name of the input parameter for a specific primary model
getNameFor(BrAPIType) - Method in class org.brapi.schematools.core.graphql.options.AbstractGraphQLOptions: Gets the name of query or mutation for a specific primary model
getNameFor(BrAPIType) - Method in class org.brapi.schematools.core.graphql.options.IdsOptions: Gets the name of id for a specific primary model.
getNameFor(BrAPIType) - Method in class org.brapi.schematools.core.graphql.options.InputOptions: Gets the name of input parameter for a specific primary model
getNewRequestNameFor(String) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Gets the name for the NewRequest schema for a specific Primary Model
getNewRequestNameFor(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Gets the name for the NewRequest schema for a specific Primary Model
getOtherErrors() - Method in class org.brapi.schematools.core.response.Response: Get the other errors in this response
getPathItemNameFor(String) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Gets the path item name for a specific Primary Model
getPathItemNameFor(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Gets the path item name for a specific Primary Model
getPathItemWithIdNameFor(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Gets the path item with id name for a specific Primary Model
getPermissionErrors() - Method in class org.brapi.schematools.core.response.Response: Get the permission errors in this response
getPluralFor(String) - Method in class org.brapi.schematools.core.options.AbstractGeneratorOptions: Gets the Pluralised name for a specific Primary Model.
getPluralFor(BrAPIType) - Method in class org.brapi.schematools.core.options.AbstractGeneratorOptions: Gets the pluralised name for a specific Primary Model.
getPluralPropertyNameFor(String) - Method in class org.brapi.schematools.core.options.PropertyOptions: Gets the plural property name for a specific primary model.
getPluralPropertyNameFor(BrAPIType) - Method in class org.brapi.schematools.core.options.PropertyOptions: Gets the plural property name for a specific primary model.
getPropertyNameFor(String) - Method in class org.brapi.schematools.core.options.PropertyOptions: Gets the property name for a specific primary model.
getPropertyNameFor(BrAPIType) - Method in class org.brapi.schematools.core.options.PropertyOptions: Gets the property name for a specific primary model.
getQueryInputParameterNameFor(String) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Gets the name of the List or Search Query input parameter for of specific primary model
getQueryInputParameterNameFor(BrAPIType) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Gets the name of the List or Search Query input parameter for of specific primary model
getQueryInputTypeNameFor(String) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Gets the name of the List or Search Query input type for of specific primary model
getQueryInputTypeNameFor(BrAPIType) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Gets the name of the List or Search Query input type for of specific primary model
getResponseTypeNameForQuery(String) - Method in class org.brapi.schematools.core.graphql.options.AbstractGraphQLQueryOptions: Gets the response type name of the query for a specific primary model
getResponseTypeNameForType(String) - Method in class org.brapi.schematools.core.graphql.options.AbstractGraphQLQueryOptions: Gets the response type name for a specific primary model
getResult() - Method in class org.brapi.schematools.core.response.Response: Get the result of this response if there are no errors.
getResultIfPresentOrElseResult(Supplier<T>) - Method in class org.brapi.schematools.core.response.Response: If response has no errors and the result is not null return the result, otherwise return the result from the supplier
getResultIfPresentOrElseResult(T) - Method in class org.brapi.schematools.core.response.Response: If response has no errors and the result is not null return the result, otherwise return the provider result from the supplier
getResultOrThrow() - Method in class org.brapi.schematools.core.response.Response: Get the result of this response if there are no errors in this response, or throws an ResponseFailedException
getResultOrThrow(Exception) - Method in class org.brapi.schematools.core.response.Response: Get the result of this response if there are no errors in this response, otherwise throws the provided exception
getResultOrThrow(Function<Response<?>, ? extends RuntimeException>) - Method in class org.brapi.schematools.core.response.Response: Get the result of this response if there are no errors in this response, otherwise obtains an exception from the function to be thrown.
getResultOrThrow(Supplier<RuntimeException>) - Method in class org.brapi.schematools.core.response.Response: Get the result of this response if there are no errors in this response, otherwise obtains an exception from the supplier to be thrown.
getRetrieveDescriptionFormat(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.SearchOptions: Gets the retrieve description for a specific primary model
getSearchQueryNameFor(String) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Gets the name of the Search Query of specific primary model
getSearchRequestNameFor(String) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Gets the name for the Search Request schema for a specific Primary Model
getSearchRequestNameFor(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Gets the name for the Search Request schema for a specific Primary Model
getSingleQueryNameFor(String) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Gets the name of the Single Query of specific primary model
getSingleResponseNameFor(String) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Gets the name for the Single Response schema for a specific Primary Model
getSingleResponseNameFor(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Gets the name for the Single Response schema for a specific Primary Model
getSingularForProperty(String) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Gets the singular name for pluralised property name
getSubmitDescriptionFormat(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.SearchOptions: Gets the submit description for a specific primary model
getSubPathItemNameFor(String, BrAPIObjectProperty) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Gets the name of the Sub-path endpoint for a property
getSummaryFor(String) - Method in class org.brapi.schematools.core.openapi.generator.options.AbstractOpenAPIOptions: Gets the summary for a specific primary model
getSummaryFor(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.AbstractOpenAPIOptions: Gets the summary for a specific primary model
getSummaryOrDefault(String, String) - Method in class org.brapi.schematools.core.openapi.generator.metadata.AbstractOpenAPIMetadata: Gets the summary for a specific primary model
getSummaryOrDefault(BrAPIType, String) - Method in class org.brapi.schematools.core.openapi.generator.metadata.AbstractOpenAPIMetadata: Gets the summary for a specific primary model
getTagFor(String) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Gets the tag name for a specific Primary Model.
getTagFor(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Gets the tag name for a specific Primary Model.
getTitleFor(String) - Method in class org.brapi.schematools.core.openapi.generator.metadata.OpenAPIGeneratorMetadata: Gets the specification title for a specification generated for a module or class
getTypeNameFor(String) - Method in class org.brapi.schematools.core.graphql.options.InputOptions: Gets the type name of the input for a specific primary model
getTypeNameFor(BrAPIType) - Method in class org.brapi.schematools.core.graphql.options.InputOptions: Gets the type name of the input for a specific primary model
getTypeNameForQuery(String) - Method in class org.brapi.schematools.core.graphql.options.InputOptions: Gets the type name of the input for a query
getUpdateMutationNameFor(String) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Gets the name of the Update Mutation of specific primary model
getValidationErrors() - Method in class org.brapi.schematools.core.response.Response: Get the validation errors in this response
GraphQLGenerator - Class in org.brapi.schematools.core.graphql: Generates a GraphQL schema from a BrAPI Json Schema.
GraphQLGenerator() - Constructor for class org.brapi.schematools.core.graphql.GraphQLGenerator: Creates a GraphQLGenerator using a default BrAPISchemaReader and the default GraphQLGeneratorOptions.
GraphQLGenerator(GraphQLGeneratorOptions) - Constructor for class org.brapi.schematools.core.graphql.GraphQLGenerator: Creates a GraphQLGenerator using a default BrAPISchemaReader and the provided GraphQLGeneratorOptions.
GraphQLGeneratorMetadata - Class in org.brapi.schematools.core.graphql.metadata: Provides metadata for the GraphQL generation
GraphQLGeneratorMetadata() - Constructor for class org.brapi.schematools.core.graphql.metadata.GraphQLGeneratorMetadata
GraphQLGeneratorOptions - Class in org.brapi.schematools.core.graphql.options: Options for the GraphQLGenerator.
GraphQLGeneratorOptions() - Constructor for class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions
GraphQLMarkdownGenerator - Class in org.brapi.schematools.core.markdown: Generates a Markdown files for type and their field descriptions from a GraphQL Schema.
GraphQLMarkdownGeneratorOptions - Class in org.brapi.schematools.core.markdown: Options for the GraphQLGenerator.
GraphQLMarkdownGeneratorOptions() - Constructor for class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions
GraphQLSchemaParser - Class in org.brapi.schematools.core.graphql: Parser for converting the result of a introspection query into a GraphQLSchema, and vice versa.
GraphQLSchemaParser() - Constructor for class org.brapi.schematools.core.graphql.GraphQLSchemaParser: Creates a new Parser with a standard ObjectMapper
GraphQLSchemaParser(ObjectMapper) - Constructor for class org.brapi.schematools.core.graphql.GraphQLSchemaParser: Creates a new Parser with a predefined ObjectMapper

H

hasErrors() - Method in class org.brapi.schematools.core.response.Response: Determines if this response has any errors.
hasInputFor(String) - Method in class org.brapi.schematools.core.graphql.options.AbstractGraphQLQueryOptions: Determines if the Query accepts an input object for a specific primary model
hasInputFor(String) - Method in class org.brapi.schematools.core.openapi.generator.options.ListGetOptions: Determines if the List Endpoint is has an input for any primary model.
hasInputFor(BrAPIType) - Method in class org.brapi.schematools.core.graphql.options.AbstractGraphQLQueryOptions: Determines if the Query accepts an input object for a specific primary model
hasInputFor(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.ListGetOptions: Determines if the List Endpoint has an input for any primary model.
hasNoErrors() - Method in class org.brapi.schematools.core.response.Response: Determines if this response has no errors.
hasPaging() - Method in class org.brapi.schematools.core.graphql.options.ListQueryOptions: Determine if any list query has paging
HTML - Enum constant in enum class org.brapi.schematools.core.openapi.comparator.ComparisonOutputFormat: Use this to render the comparison output in HTML format
HTMLRenderOptions - Class in org.brapi.schematools.core.openapi.comparator.options: HTML Options for the OpenAPIComparator.
HTMLRenderOptions() - Constructor for class org.brapi.schematools.core.openapi.comparator.options.HTMLRenderOptions

I

ID - Enum constant in enum class org.brapi.schematools.core.graphql.options.LinkType: The property value will be linked to the parent object via an ID, usually the DbId
ID - Enum constant in enum class org.brapi.schematools.core.openapi.generator.LinkType: The property value will be linked to the parent object via an ID, usually the DbId
IdsOptions - Class in org.brapi.schematools.core.graphql.options: Provides options for the generation of Ids
IdsOptions() - Constructor for class org.brapi.schematools.core.graphql.options.IdsOptions
ifPresentMapResultToResponseOr(Function<T, Response>, Supplier<Response>) - Method in class org.brapi.schematools.core.response.Response: If response has no errors and the result is not null apply the function to the result, otherwise use the to get the new resource
INPUT_PATTERN - Static variable in class org.brapi.schematools.core.markdown.GraphQLMarkdownGenerator: Pattern for Input names
InputOptions - Class in org.brapi.schematools.core.graphql.options: The options used to generate Input object types
InputOptions() - Constructor for class org.brapi.schematools.core.graphql.options.InputOptions
INTEGER - Static variable in class org.brapi.schematools.core.model.BrAPIPrimitiveType: Boolean Integer Type
isCreatingTopLevelArgumentDefinitions() - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Determines if the Generator should create top level argument descriptions when there is more than one argument with the same name.
isCreatingTopLevelFieldDefinitions() - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Determines if the Generator should create top level field descriptions when there is more than one field with the same name.
isCreatingTopLevelInputFieldDefinitions() - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Determines if the Generator should create top level input object field descriptions when there is more than one field with the same name.
isEmpty() - Method in class org.brapi.schematools.core.response.Response: Determines if response has no errors and the result is null
isGenerating() - Method in class org.brapi.schematools.core.options.AbstractGeneratorSubOptions: Determines if the Endpoint/Query/Mutation is generated for any primary model.
isGeneratingCreateMutation() - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Determines if the Generator should generate the New mutations.
isGeneratingCreateMutationFor(String) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Determines if the Generator should generate the New mutation for a specific Primary Model.
isGeneratingDeleteMutation() - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Determines if the Generator should generate the Delete mutations.
isGeneratingDeleteMutationFor(String) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Determines if the Generator should generate the Delete mutation for a specific Primary Model.
isGeneratingEndpoint() - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Determines if the Generator should generate any Endpoints without an ID parameter.
isGeneratingEndpointFor(String) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Determines if the Generator should generate the Endpoints without an ID parameter for a specific Primary Model.
isGeneratingEndpointFor(String) - Method in class org.brapi.schematools.core.openapi.generator.options.PutOptions: Determines if generating a PUT endpoint with no ID parameter for a specific model
isGeneratingEndpointFor(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Determines if the Generator should generate the Endpoints without an ID parameter for a specific Primary Model.
isGeneratingEndpointFor(BrAPIObjectType) - Method in class org.brapi.schematools.core.openapi.generator.options.PutOptions: Determines if generating a PUT endpoint with no ID parameter for a specific model
isGeneratingEndpointNameWithIdFor(String) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Determines if the Generator should generate the Endpoints with an ID parameter for a specific Primary Model.
isGeneratingEndpointNameWithIdFor(String) - Method in class org.brapi.schematools.core.openapi.generator.options.PutOptions: Determines if generating a PUT endpoint with an ID parameter for a specific model
isGeneratingEndpointNameWithIdFor(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Determines if the Generator should generate the Endpoints with an ID parameter for a specific Primary Model.
isGeneratingEndpointNameWithIdFor(BrAPIObjectType) - Method in class org.brapi.schematools.core.openapi.generator.options.PutOptions: Determines if generating a PUT endpoint with an ID parameter for a specific model
isGeneratingEndpointWithId() - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Determines if the Generator should generate any Endpoints with an ID parameter.
isGeneratingFor(String) - Method in class org.brapi.schematools.core.options.AbstractGeneratorSubOptions: Determines if the Endpoint/Query/Mutation is generated for a specific primary model
isGeneratingFor(BrAPIType) - Method in class org.brapi.schematools.core.options.AbstractGeneratorSubOptions: Determines if the Endpoint/Query/Mutation is generated for a specific primary model
isGeneratingListQueries() - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Determines if the Generator should generate any List Query.
isGeneratingListQueryFor(String) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Determines if the Generator should generate the List Query for a specific Primary Model.
isGeneratingMutationType() - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Determines if the Generator should generate the Mutation Type.
isGeneratingNewRequestFor(String) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Determines if the Generator should generate a NewRequest schema, separate from the standard schema for a specific Primary Model.
isGeneratingNewRequestFor(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Determines if the Generator should generate a NewRequest schema, separate from the standard schema for a specific Primary Model.
isGeneratingQueryType() - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Determines if the Generator should generate the Query Type.
isGeneratingSearchQueries() - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Determines if the Generator should generate any Search Query.
isGeneratingSearchQueryFor(String) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Determines if the Generator should generate the Search Query for a specific Primary Model.
isGeneratingSingleQueries() - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Determines if the Generator should generate any single query.
isGeneratingSingleQueryFor(String) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Determines if the Generator should generate the single query for a specific Primary Model.
isGeneratingSubPathFor(BrAPIObjectType, BrAPIObjectProperty) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Determines if a specific property should be exposed as a separate Endpoint
isGeneratingUpdateMutation() - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Determines if the Generator should generate the Update mutations.
isGeneratingUpdateMutationFor(String) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Determines if the Generator should generate the Update mutation for a specific Primary Model.
isJSONEqual(String, String) - Static method in class org.brapi.schematools.core.utils.StringUtils: Compare two JSON strings to if they are the same.
isLink() - Method in class org.brapi.schematools.core.options.PropertyOptions: Get if this property is used as a foreign key link between entities
isMergingOneOfType(BrAPIClass) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Gets if the possible types of a 'OneOf' type are merged into a single type.
isMultilineEqual(String, String) - Static method in class org.brapi.schematools.core.utils.StringUtils: Compare two multiline strings to if they are the same.
isMultiple() - Method in class org.brapi.schematools.core.graphql.options.CreateMutationOptions: Determines if the mutation accepts multiple object or just one
isMultiple() - Method in class org.brapi.schematools.core.graphql.options.DeleteMutationOptions: Determines if the mutation accepts multiple object or just one
isMultiple() - Method in class org.brapi.schematools.core.graphql.options.UpdateMutationOptions: Determines if the mutation accepts multiple object or just one
isMultipleFor(String) - Method in class org.brapi.schematools.core.openapi.generator.options.PutOptions: Determines if the PUT Endpoint accepts multiple entities for a specific model
isMultipleFor(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.PutOptions: Determines if the PUT Endpoint accepts multiple entities for a specific model
isNonPrimaryModel(BrAPIClass) - Static method in class org.brapi.schematools.core.utils.BrAPITypeUtils: Determines if a BrAPI Class is a Not primary model
isNotBlank(String) - Static method in class org.brapi.schematools.core.utils.StringUtils: Check if a string is not null and not blank
isOverwritingExistingFiles() - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Determines if the Generator should Overwrite exiting files.
isPagedFor(String) - Method in class org.brapi.schematools.core.graphql.options.ListQueryOptions: Determines if the Query is paged for a specific primary model
isPagedFor(String) - Method in class org.brapi.schematools.core.openapi.generator.options.ListGetOptions: Determines if the List Endpoint is paged for any primary model.
isPagedFor(BrAPIType) - Method in class org.brapi.schematools.core.graphql.options.ListQueryOptions: Determines if the Query is paged for a specific primary model
isPagedFor(BrAPIType) - Method in class org.brapi.schematools.core.openapi.generator.options.ListGetOptions: Determines if the List Endpoint is paged for any primary model.
isPartitionedByCrop() - Method in class org.brapi.schematools.core.graphql.options.QueryTypeOptions: Determines if the query is partition by crop, so that queries are not across crops
isPluralisingName() - Method in class org.brapi.schematools.core.graphql.options.AbstractGraphQLOptions: Determines if the query or mutation should have a plurialised name
isPresent() - Method in class org.brapi.schematools.core.response.Response: Determines if response has no errors and the result is not null
isPrettyPrinting() - Method in class org.brapi.schematools.core.openapi.comparator.options.JSONRenderOptions: Determines if the Comparator should pretty print any output
isPrimaryModel(BrAPIClass) - Static method in class org.brapi.schematools.core.utils.BrAPITypeUtils: Determines if a BrAPI Class is a primary model
isSeparatingByModule() - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Determines if the Generator should generate a separate specification per module.
isShowingAllChanges() - Method in class org.brapi.schematools.core.openapi.comparator.options.HTMLRenderOptions: Determines if the Comparator HTML render should show all changes
isShowingChangedMetadata() - Method in class org.brapi.schematools.core.openapi.comparator.options.MarkdownRenderOptions: Determines if the Markdown Render should show changes in the metadata such as summary and description
isUsingIDType() - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Determines if the built-in GraphQLID type should be used for IDs instead of GraphQLString
isUsingIDType() - Method in class org.brapi.schematools.core.graphql.options.IdsOptions: Determines if the built-in GraphQLID type should be used for IDs instead of GraphQLString
isUsingPropertyFromRequestFor(BrAPIObjectType, BrAPIObjectProperty) - Method in class org.brapi.schematools.core.openapi.generator.options.ListGetOptions: Gets whether a property from the Request is used in the List query
isValid() - Method in class org.brapi.schematools.core.validiation.Validation: Was the validation successful,

J

JSON - Enum constant in enum class org.brapi.schematools.core.openapi.comparator.ComparisonOutputFormat: Use this to render the comparison output in JSON format
JsonRender - Class in org.brapi.schematools.core.openapi.comparator: A modified render for JSON that allows pretty print.
JsonRender(boolean) - Constructor for class org.brapi.schematools.core.openapi.comparator.JsonRender
JSONRenderOptions - Class in org.brapi.schematools.core.openapi.comparator.options: JSONRender Options for the OpenAPIComparator..
JSONRenderOptions() - Constructor for class org.brapi.schematools.core.openapi.comparator.options.JSONRenderOptions
justDo(Supplier<Void>) - Method in class org.brapi.schematools.core.response.Response: Call the supplier and return this
justDoOnCondition(boolean, Supplier<Void>) - Method in class org.brapi.schematools.core.response.Response: If the condition is true call the supplier, otherwise don't call the supplier

L

LinkType - Enum Class in org.brapi.schematools.core.graphql.options: Determines how a child property value is linked to the parent object
LinkType - Enum Class in org.brapi.schematools.core.openapi.generator: Determines how a child property value is linked to the parent object
LIST_RESPONSE_PATTERN - Static variable in class org.brapi.schematools.core.markdown.GraphQLMarkdownGenerator: Pattern for List Response names
ListGetMetadata - Class in org.brapi.schematools.core.openapi.generator.metadata: Provides metadata for the List Get endpoints
ListGetMetadata() - Constructor for class org.brapi.schematools.core.openapi.generator.metadata.ListGetMetadata
ListGetOptions - Class in org.brapi.schematools.core.openapi.generator.options: Provides options for the generation of List Get Endpoints
ListGetOptions() - Constructor for class org.brapi.schematools.core.openapi.generator.options.ListGetOptions
ListQueryOptions - Class in org.brapi.schematools.core.graphql.options: Provides options for the generation of List Queries
ListQueryOptions() - Constructor for class org.brapi.schematools.core.graphql.options.ListQueryOptions
load() - Static method in class org.brapi.schematools.core.graphql.metadata.GraphQLGeneratorMetadata: Load the default metadata
load() - Static method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Load the default options
load() - Static method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Load the default options
load() - Static method in class org.brapi.schematools.core.ontmodel.metadata.OntModelGeneratorMetadata: Load the default metadata
load() - Static method in class org.brapi.schematools.core.ontmodel.options.OntModelGeneratorOptions: Load the default options
load() - Static method in class org.brapi.schematools.core.openapi.comparator.options.OpenAPIComparatorOptions: Load the default options
load() - Static method in class org.brapi.schematools.core.openapi.generator.metadata.OpenAPIGeneratorMetadata: Load the default metadata
load() - Static method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Load the default options
load() - Static method in class org.brapi.schematools.core.xlsx.options.XSSFWorkbookGeneratorOptions: Load the default options
load(InputStream) - Static method in class org.brapi.schematools.core.graphql.metadata.GraphQLGeneratorMetadata: Load the metadata from an metadata input stream in YAML or Json.
load(InputStream) - Static method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Load the options from an options input stream in YAML or Json.
load(InputStream) - Static method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Load the options from an options input stream in YAML or Json.
load(InputStream) - Static method in class org.brapi.schematools.core.ontmodel.metadata.OntModelGeneratorMetadata: Load the metadata from a metadata input stream in YAML or Json.
load(InputStream) - Static method in class org.brapi.schematools.core.ontmodel.options.OntModelGeneratorOptions: Load the options from an options input stream in YAML or Json.
load(InputStream) - Static method in class org.brapi.schematools.core.openapi.comparator.options.OpenAPIComparatorOptions: Load the options from an option input stream in YAML or JSON.
load(InputStream) - Static method in class org.brapi.schematools.core.openapi.generator.metadata.OpenAPIGeneratorMetadata: Load the metadata from an metadata input stream in YAML or Json.
load(InputStream) - Static method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Load the options from an options input stream in YAML or Json.
load(InputStream) - Static method in class org.brapi.schematools.core.xlsx.options.XSSFWorkbookGeneratorOptions: Load the options from an options input stream in YAML or JSON.
load(InputStream, Class<T>) - Static method in class org.brapi.schematools.core.utils.ConfigurationUtils: Load the configurations from an input stream in YAML or Json.
load(String, Class<T>) - Static method in class org.brapi.schematools.core.utils.ConfigurationUtils: Load the default configurations from the classpath
load(Path) - Static method in class org.brapi.schematools.core.graphql.metadata.GraphQLGeneratorMetadata: Load the metadata from a metadata file in YAML or Json.
load(Path) - Static method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Load the options from an options file in YAML or Json.
load(Path) - Static method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Load the options from an options file in YAML or Json.
load(Path) - Static method in class org.brapi.schematools.core.ontmodel.metadata.OntModelGeneratorMetadata: Load the metadata from a metadata file in YAML or Json.
load(Path) - Static method in class org.brapi.schematools.core.ontmodel.options.OntModelGeneratorOptions: Load the options from an options file in YAML or Json.
load(Path) - Static method in class org.brapi.schematools.core.openapi.comparator.options.OpenAPIComparatorOptions: Load the options from an option file in YAML or Json.
load(Path) - Static method in class org.brapi.schematools.core.openapi.generator.metadata.OpenAPIGeneratorMetadata: Load the metadata from a metadata file in YAML or Json.
load(Path) - Static method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Load the options from an options file in YAML or Json.
load(Path) - Static method in class org.brapi.schematools.core.xlsx.options.XSSFWorkbookGeneratorOptions: Load the options from an options file in YAML or Json.
load(Path, Class<T>) - Static method in class org.brapi.schematools.core.utils.ConfigurationUtils: Load the configurations from a file in YAML or Json.

M

makeValidName(String) - Static method in class org.brapi.schematools.core.utils.StringUtils: Creates a valid name for use in GraphQL
MANY_TO_MANY - Enum constant in enum class org.brapi.schematools.core.model.BrAPIRelationshipType: A relationship that denotes a many-to-many relationship
MANY_TO_ONE - Enum constant in enum class org.brapi.schematools.core.model.BrAPIRelationshipType: A relationship that denotes a many-to-one relationship
map(Function<Response<T>, Response>) - Method in class org.brapi.schematools.core.response.Response: Merges the response from the function if this response has no errors, otherwise create a new response and merges in the errors from this response.
map(Supplier<Response>) - Method in class org.brapi.schematools.core.response.Response: Merges the response from the supplier if this response has no errors, otherwise create a new response and merges in the errors from this response.
mapErrors(Function<Response<T>, Response<C>>) - Method in class org.brapi.schematools.core.response.Response: Map the errors response of the provided function executed on this response, removing any existing errors on this response
mapOnCondition(boolean, Function<Response<T>, Response>) - Method in class org.brapi.schematools.core.response.Response: If the condition is true and there are no errors from this response merge the response obtained from the provided function, otherwise create a new response and merge in the errors from this response.
mapOnCondition(boolean, Supplier<Response>) - Method in class org.brapi.schematools.core.response.Response: If the condition is true and there are no errors from this response merge any errors from this response into response obtained from the provided supplier, otherwise create a new response and merge in the errors from this response.
mapResponseOnCondition(boolean, Function<T, Response>) - Method in class org.brapi.schematools.core.response.Response: If the condition is true merges any errors from this response into response obtained from the provided function, otherwise create a new response and merges in the errors from this response.
mapResult(Function<T, U>) - Method in class org.brapi.schematools.core.response.Response: If this response has no errors returns a new response that takes the result of provided function that takes the result of this resource as an input, otherwise create a new response and merges in the errors from this response.
mapResultErrors(Function<T, Response<C>>) - Method in class org.brapi.schematools.core.response.Response: If this response has no errors it maps result of the provided function executed on the result on this response
mapResultOnCondition(boolean, Function<T, U>) - Method in class org.brapi.schematools.core.response.Response: If condition is true and this response has no errors returns a new response that takes the result of provided function that takes the result of this resource as an input, otherwise create a new response and merges in the errors from this response.
mapResultToResponse(Function<T, Response>) - Method in class org.brapi.schematools.core.response.Response: If this response has no errors use the function to get the new response
MARKDOWN - Enum constant in enum class org.brapi.schematools.core.openapi.comparator.ComparisonOutputFormat: Use this to render the comparison output in Markdown format
MarkdownGenerator - Class in org.brapi.schematools.core.markdown: Generates a Markdown files for type and their field descriptions from a BrAPI Json Schema.
MarkdownGenerator() - Constructor for class org.brapi.schematools.core.markdown.MarkdownGenerator
MarkdownRenderOptions - Class in org.brapi.schematools.core.openapi.comparator.options: Markdown Render Options for the OpenAPIComparator..
MarkdownRenderOptions() - Constructor for class org.brapi.schematools.core.openapi.comparator.options.MarkdownRenderOptions
merge(Supplier<Response>) - Method in class org.brapi.schematools.core.response.Response: Merges any errors from this response into response obtained from the provider supplier, the result from this response is lost.
merge(List<T>) - Method in class org.brapi.schematools.core.validiation.Validation: Merge the objects to Validation, by calling the Validatable.validate() method in each object and adding any errors to this Validation
merge(Response<?>) - Method in class org.brapi.schematools.core.validiation.Validation: Merge the Response to Validation, by adding any errors to this Validation
merge(Response) - Method in class org.brapi.schematools.core.response.Response: Merges any errors from this response into provided response, the result from this response is lost.
merge(Validatable) - Method in class org.brapi.schematools.core.validiation.Validation: Merge the objects to Validation, by calling the Validatable.validate() method and adding any errors to this Validation
merge(Validatable, String) - Method in class org.brapi.schematools.core.validiation.Validation: Merge the objects to Validation, by calling the Validatable.validate() method and adding any errors to this Validation
merge(Validation) - Method in class org.brapi.schematools.core.response.Response: Merges any errors from the validation,
mergeErrors(Supplier<Response<C>>) - Method in class org.brapi.schematools.core.response.Response: Merge the errors from the provided response supplier into this response
mergeErrors(Response<?>) - Method in class org.brapi.schematools.core.response.Response: Merge the errors from the provided response into this response
mergeLists() - Static method in class org.brapi.schematools.core.response.Response: Combines all the results a stream of Responses of type List<T>into a single Response that has a result of type List<T>, merging any errors from the individual responses into the returned response.
mergeOnCondition(boolean, Supplier<Response>) - Method in class org.brapi.schematools.core.response.Response: If the condition is true merges any errors from this response into response obtained from the provided supplier, the result from this response is lost.
mergeOnCondition(boolean, Validatable) - Method in class org.brapi.schematools.core.validiation.Validation: If the condition is true, merge the objects to Validation, by calling the Validatable.validate() method and adding any errors to this Validation
mergeOnCondition(boolean, Validatable, String) - Method in class org.brapi.schematools.core.validiation.Validation: If the condition is true, merge the objects to Validation, by calling the Validatable.validate() method and adding any errors to this Validation
Metadata - Interface in org.brapi.schematools.core.metadata: A class that provide metadata to a generator
MutationTypeOptions - Class in org.brapi.schematools.core.graphql.options: Provides options for the generation of the Mutation Type
MutationTypeOptions() - Constructor for class org.brapi.schematools.core.graphql.options.MutationTypeOptions

N

NONE - Enum constant in enum class org.brapi.schematools.core.graphql.options.LinkType: The property value will be not be exposed in the parent object
NONE - Enum constant in enum class org.brapi.schematools.core.openapi.generator.LinkType: The property value will be not be exposed in the parent object
NUMBER - Static variable in class org.brapi.schematools.core.model.BrAPIPrimitiveType: Boolean Number Type

O

ONE_TO_MANY - Enum constant in enum class org.brapi.schematools.core.model.BrAPIRelationshipType: A relationship that denotes a one-to-many relationship
ONE_TO_ONE - Enum constant in enum class org.brapi.schematools.core.model.BrAPIRelationshipType: A relationship that denotes a one-to-one relationship
onFailDo(Runnable) - Method in class org.brapi.schematools.core.response.Response: If this response has errors run the action and return this
onFailDoWithResponse(Consumer<Response<T>>) - Method in class org.brapi.schematools.core.response.Response: If this response has no errors pass this response to the provider consumer
onSuccessDo(Runnable) - Method in class org.brapi.schematools.core.response.Response: If this response has no errors run the action and return this
onSuccessDo(Consumer<Response<T>>) - Method in class org.brapi.schematools.core.response.Response: If this response has no errors pass this response to the provider consumer
onSuccessDo(Supplier<Void>) - Method in class org.brapi.schematools.core.response.Response: If this response has no errors call the supplier and return this
onSuccessDoOnCondition(boolean, Runnable) - Method in class org.brapi.schematools.core.response.Response: If the condition is true and this response has no errors call run the action and return this
onSuccessDoOnCondition(Predicate<T>, Runnable) - Method in class org.brapi.schematools.core.response.Response: If the predicate returns true and this response has no errors call run the action and return this
onSuccessDoOnCondition(Predicate<T>, Supplier<Void>) - Method in class org.brapi.schematools.core.response.Response: If the predicate returns true and this response has no errors call the supplier and return this
onSuccessDoWithResult(Consumer<T>) - Method in class org.brapi.schematools.core.response.Response: If this response has no errors pass the result of this response to the provider consumer
onSuccessDoWithResultOnCondition(boolean, Consumer<T>) - Method in class org.brapi.schematools.core.response.Response: If the condition is true and this response has no errors pass the result of this response to the provider consumer
OntModelGenerator - Class in org.brapi.schematools.core.ontmodel: Generates an Ontology Model from a BrAPI Json Schema.
OntModelGenerator() - Constructor for class org.brapi.schematools.core.ontmodel.OntModelGenerator: Creates a OntModelGenerator using a default BrAPISchemaReader and the default OntModelGeneratorOptions.
OntModelGenerator(OntModelGeneratorOptions) - Constructor for class org.brapi.schematools.core.ontmodel.OntModelGenerator: Creates a OntModelGenerator using a default BrAPISchemaReader and the provided OntModelGeneratorOptions.
OntModelGeneratorMetadata - Class in org.brapi.schematools.core.ontmodel.metadata: Provides metadata for the RDF Graph generation
OntModelGeneratorMetadata() - Constructor for class org.brapi.schematools.core.ontmodel.metadata.OntModelGeneratorMetadata
OntModelGeneratorOptions - Class in org.brapi.schematools.core.ontmodel.options: Options for the GraphQLGenerator.
OntModelGeneratorOptions() - Constructor for class org.brapi.schematools.core.ontmodel.options.OntModelGeneratorOptions
OpenAPIComparator - Class in org.brapi.schematools.core.openapi.comparator: Compares two OpenAPI Specifications
OpenAPIComparator() - Constructor for class org.brapi.schematools.core.openapi.comparator.OpenAPIComparator: Creates a Comparator with default options
OpenAPIComparatorOptions - Class in org.brapi.schematools.core.openapi.comparator.options: Options for the OpenAPIComparator.
OpenAPIComparatorOptions() - Constructor for class org.brapi.schematools.core.openapi.comparator.options.OpenAPIComparatorOptions
OpenAPIComponentsException - Exception Class in org.brapi.schematools.core.openapi.generator: Exception thrown during the generation of BrAPI OpenAPI Specification
OpenAPIComponentsException(Exception) - Constructor for exception class org.brapi.schematools.core.openapi.generator.OpenAPIComponentsException: Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
OpenAPIComponentsReader - Class in org.brapi.schematools.core.openapi.generator: Utility class for reading OpenAPI Components from YAML files.
OpenAPIComponentsReader() - Constructor for class org.brapi.schematools.core.openapi.generator.OpenAPIComponentsReader
OpenAPIGenerator - Class in org.brapi.schematools.core.openapi.generator: Generates an OpenAPI Specification from a BrAPI Json Schema.
OpenAPIGenerator() - Constructor for class org.brapi.schematools.core.openapi.generator.OpenAPIGenerator: Creates a OpenAPIGenerator using a default BrAPISchemaReader and the default OpenAPIGeneratorOptions.
OpenAPIGenerator(OpenAPIGeneratorOptions) - Constructor for class org.brapi.schematools.core.openapi.generator.OpenAPIGenerator: Creates a GraphQLGenerator using a default BrAPISchemaReader and the provided OpenAPIGeneratorOptions.
OpenAPIGeneratorMetadata - Class in org.brapi.schematools.core.openapi.generator.metadata: Provides metadata for the OpenAPI generation
OpenAPIGeneratorMetadata() - Constructor for class org.brapi.schematools.core.openapi.generator.metadata.OpenAPIGeneratorMetadata
OpenAPIGeneratorOptions - Class in org.brapi.schematools.core.openapi.generator.options: Options for the OpenAPIGenerator.
OpenAPIGeneratorOptions() - Constructor for class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions
OpenAPIUtils - Class in org.brapi.schematools.core.utils
OpenAPIUtils() - Constructor for class org.brapi.schematools.core.utils.OpenAPIUtils
options(GraphQLMarkdownGeneratorOptions) - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGenerator: Overwrite the files if present.
Options - Interface in org.brapi.schematools.core.options: A class that provide options to a generator
or(Function<Response<T>, Response<T>>) - Method in class org.brapi.schematools.core.response.Response: Returns this response if this response has no errors, otherwise create a new response and merges in the errors from this response.
or(Supplier<Response<T>>) - Method in class org.brapi.schematools.core.response.Response: Returns this response if it has no errors, otherwise returns the provided response from the supplier
orElse(Response<T>) - Method in class org.brapi.schematools.core.response.Response: Returns this response if it has no errors, otherwise returns the provided response
orElseGetResult(Supplier<T>) - Method in class org.brapi.schematools.core.response.Response: Get the result of this response if there are no errors in this response, otherwise returns supplier is used to provide result
orElseResult(T) - Method in class org.brapi.schematools.core.response.Response: Get the result of this response if there are no errors in this response, otherwise returns the provided result
org.brapi.schematools.core.brapischema - package org.brapi.schematools.core.brapischema
org.brapi.schematools.core.graphql - package org.brapi.schematools.core.graphql
org.brapi.schematools.core.graphql.metadata - package org.brapi.schematools.core.graphql.metadata
org.brapi.schematools.core.graphql.options - package org.brapi.schematools.core.graphql.options
org.brapi.schematools.core.markdown - package org.brapi.schematools.core.markdown
org.brapi.schematools.core.metadata - package org.brapi.schematools.core.metadata
org.brapi.schematools.core.model - package org.brapi.schematools.core.model
org.brapi.schematools.core.ontmodel - package org.brapi.schematools.core.ontmodel
org.brapi.schematools.core.ontmodel.metadata - package org.brapi.schematools.core.ontmodel.metadata
org.brapi.schematools.core.ontmodel.options - package org.brapi.schematools.core.ontmodel.options
org.brapi.schematools.core.openapi.comparator - package org.brapi.schematools.core.openapi.comparator
org.brapi.schematools.core.openapi.comparator.options - package org.brapi.schematools.core.openapi.comparator.options
org.brapi.schematools.core.openapi.generator - package org.brapi.schematools.core.openapi.generator
org.brapi.schematools.core.openapi.generator.metadata - package org.brapi.schematools.core.openapi.generator.metadata
org.brapi.schematools.core.openapi.generator.options - package org.brapi.schematools.core.openapi.generator.options
org.brapi.schematools.core.options - package org.brapi.schematools.core.options
org.brapi.schematools.core.response - package org.brapi.schematools.core.response
org.brapi.schematools.core.utils - package org.brapi.schematools.core.utils
org.brapi.schematools.core.validiation - package org.brapi.schematools.core.validiation
org.brapi.schematools.core.xlsx - package org.brapi.schematools.core.xlsx
org.brapi.schematools.core.xlsx.options - package org.brapi.schematools.core.xlsx.options
OTHER - Enum constant in enum class org.brapi.schematools.core.response.Response.ErrorType: Any other types of error
outputPath(Path) - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGenerator: Sets the output path.
override(GraphQLGeneratorMetadata) - Method in class org.brapi.schematools.core.graphql.metadata.GraphQLGeneratorMetadata: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(AbstractGraphQLOptions) - Method in class org.brapi.schematools.core.graphql.options.AbstractGraphQLOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(AbstractGraphQLQueryOptions) - Method in class org.brapi.schematools.core.graphql.options.AbstractGraphQLQueryOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(CreateMutationOptions) - Method in class org.brapi.schematools.core.graphql.options.CreateMutationOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(DeleteMutationOptions) - Method in class org.brapi.schematools.core.graphql.options.DeleteMutationOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(GraphQLGeneratorOptions) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(IdsOptions) - Method in class org.brapi.schematools.core.graphql.options.IdsOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(InputOptions) - Method in class org.brapi.schematools.core.graphql.options.InputOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(ListQueryOptions) - Method in class org.brapi.schematools.core.graphql.options.ListQueryOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(MutationTypeOptions) - Method in class org.brapi.schematools.core.graphql.options.MutationTypeOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(PropertiesOptions) - Method in class org.brapi.schematools.core.graphql.options.PropertiesOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(QueryTypeOptions) - Method in class org.brapi.schematools.core.graphql.options.QueryTypeOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(SearchQueryOptions) - Method in class org.brapi.schematools.core.graphql.options.SearchQueryOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(UpdateMutationOptions) - Method in class org.brapi.schematools.core.graphql.options.UpdateMutationOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(GraphQLMarkdownGeneratorOptions) - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(OntModelGeneratorMetadata) - Method in class org.brapi.schematools.core.ontmodel.metadata.OntModelGeneratorMetadata: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(AsciiDocRenderOptions) - Method in class org.brapi.schematools.core.openapi.comparator.options.AsciiDocRenderOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(HTMLRenderOptions) - Method in class org.brapi.schematools.core.openapi.comparator.options.HTMLRenderOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(JSONRenderOptions) - Method in class org.brapi.schematools.core.openapi.comparator.options.JSONRenderOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(MarkdownRenderOptions) - Method in class org.brapi.schematools.core.openapi.comparator.options.MarkdownRenderOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(OpenAPIComparatorOptions) - Method in class org.brapi.schematools.core.openapi.comparator.options.OpenAPIComparatorOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(AbstractOpenAPIMetadata) - Method in class org.brapi.schematools.core.openapi.generator.metadata.AbstractOpenAPIMetadata: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(OpenAPIGeneratorMetadata) - Method in class org.brapi.schematools.core.openapi.generator.metadata.OpenAPIGeneratorMetadata: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(AbstractOpenAPIOptions) - Method in class org.brapi.schematools.core.openapi.generator.options.AbstractOpenAPIOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(ListGetOptions) - Method in class org.brapi.schematools.core.openapi.generator.options.ListGetOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(OpenAPIGeneratorOptions) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(PutOptions) - Method in class org.brapi.schematools.core.openapi.generator.options.PutOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(SearchOptions) - Method in class org.brapi.schematools.core.openapi.generator.options.SearchOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(AbstractGeneratorOptions) - Method in class org.brapi.schematools.core.options.AbstractGeneratorOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(AbstractGeneratorSubOptions) - Method in class org.brapi.schematools.core.options.AbstractGeneratorSubOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(PropertiesOptions) - Method in class org.brapi.schematools.core.options.PropertiesOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(PropertyOptions) - Method in class org.brapi.schematools.core.options.PropertyOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(XSSFWorkbookGeneratorOptions) - Method in class org.brapi.schematools.core.xlsx.options.XSSFWorkbookGeneratorOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null

P

parseJsonSchema(String) - Method in class org.brapi.schematools.core.graphql.GraphQLSchemaParser: Parses the result of an introspection query into a GraphQLSchema.
PERMISSION - Enum constant in enum class org.brapi.schematools.core.response.Response.ErrorType: Permission errors
PostMetadata - Class in org.brapi.schematools.core.openapi.generator.metadata: Provides metadata for the Post endpoints
PostMetadata() - Constructor for class org.brapi.schematools.core.openapi.generator.metadata.PostMetadata
PostOptions - Class in org.brapi.schematools.core.openapi.generator.options: Provides options for the generation of Post Endpoints
PostOptions() - Constructor for class org.brapi.schematools.core.openapi.generator.options.PostOptions
prettyPrint(OpenAPI) - Static method in class org.brapi.schematools.core.utils.OpenAPIUtils: Pretty print an OpenAPI object to a JSON String, with a default indentation of 4 spaces.
prettyPrint(OpenAPI, int) - Static method in class org.brapi.schematools.core.utils.OpenAPIUtils: Pretty print an OpenAPI object to a JSON String.
prettyPrint(Object) - Static method in class org.brapi.schematools.core.utils.StringUtils: Pretty print an object to a JSON String, with a default indentation of 4 spaces.
prettyPrint(Object, int) - Static method in class org.brapi.schematools.core.utils.StringUtils: Pretty print an object to a JSON String.
PropertiesOptions - Class in org.brapi.schematools.core.graphql.options: Provides options for the generation of properties and their usage
PropertiesOptions - Class in org.brapi.schematools.core.options: Provides options for the generation of ID, Name and PUI property and their usage
PropertiesOptions() - Constructor for class org.brapi.schematools.core.graphql.options.PropertiesOptions
PropertiesOptions() - Constructor for class org.brapi.schematools.core.options.PropertiesOptions
PropertyOptions - Class in org.brapi.schematools.core.options: Provides options for the generation of property and their usage
PropertyOptions() - Constructor for class org.brapi.schematools.core.options.PropertyOptions
PutMetadata - Class in org.brapi.schematools.core.openapi.generator.metadata: Provides metadata for the Put endpoints
PutMetadata() - Constructor for class org.brapi.schematools.core.openapi.generator.metadata.PutMetadata
PutOptions - Class in org.brapi.schematools.core.openapi.generator.options: Provides options for the generation of Put Endpoints
PutOptions() - Constructor for class org.brapi.schematools.core.openapi.generator.options.PutOptions

Q

QueryTypeOptions - Class in org.brapi.schematools.core.graphql.options: Provides options for the generation of the Query Type
QueryTypeOptions() - Constructor for class org.brapi.schematools.core.graphql.options.QueryTypeOptions

R

readComponents(Path) - Method in class org.brapi.schematools.core.openapi.generator.OpenAPIComponentsReader: Read OpenAPI Components from YAML files.
readDirectories(Path) - Method in class org.brapi.schematools.core.brapischema.BrAPISchemaReader: Reads the schema module directories within a parent directory, and validates between schemas.
readSchema(Path, String) - Method in class org.brapi.schematools.core.brapischema.BrAPISchemaReader: Reads a single object type from an JSON schema.
readSchema(Path, String, String) - Method in class org.brapi.schematools.core.brapischema.BrAPISchemaReader: Reads a single object type from an JSON schema string.
readStringFromPath(Path) - Static method in class org.brapi.schematools.core.utils.StringUtils: Reads a string from a file path
render(ChangedOpenApi, OutputStreamWriter) - Method in class org.brapi.schematools.core.openapi.comparator.JsonRender
Response<T> - Class in org.brapi.schematools.core.response: A generic Response class for functional programming.
RESPONSE_PATTERN - Static variable in class org.brapi.schematools.core.markdown.GraphQLMarkdownGenerator: Pattern for other Response names
Response.Error - Class in org.brapi.schematools.core.response: Wrapper around an error in the response.
Response.ErrorLogging - Interface in org.brapi.schematools.core.response: Functional Interface to support error logging.
Response.ErrorType - Enum Class in org.brapi.schematools.core.response: Type of error
ResponseFailedException - Exception Class in org.brapi.schematools.core.response: Exception thrown when Response error is handled.
ResponseFailedException(Response<?>) - Constructor for exception class org.brapi.schematools.core.response.ResponseFailedException: Constructs a new exception with failed Response

S

SEARCH_RESPONSE_PATTERN - Static variable in class org.brapi.schematools.core.markdown.GraphQLMarkdownGenerator: Pattern for Search Response names
SearchMetadata - Class in org.brapi.schematools.core.openapi.generator.metadata: Provides metadata for the Search Post and Get endpoints
SearchMetadata() - Constructor for class org.brapi.schematools.core.openapi.generator.metadata.SearchMetadata
SearchOptions - Class in org.brapi.schematools.core.openapi.generator.options: Provides options for the generation of Search Post and Get Endpoints
SearchOptions() - Constructor for class org.brapi.schematools.core.openapi.generator.options.SearchOptions
SearchQueryOptions - Class in org.brapi.schematools.core.graphql.options: Provides options for the generation of Search Queries
SearchQueryOptions() - Constructor for class org.brapi.schematools.core.graphql.options.SearchQueryOptions
setDescriptionFor(String, String) - Method in class org.brapi.schematools.core.openapi.generator.metadata.AbstractOpenAPIMetadata: Sets the description for a specific primary model.
setGenerateFor(String, boolean) - Method in class org.brapi.schematools.core.options.AbstractGeneratorSubOptions: Sets if the Endpoint/Query/Mutation is generated for a specific primary model.
setGenerateFor(BrAPIType, boolean) - Method in class org.brapi.schematools.core.options.AbstractGeneratorSubOptions: Sets if the Endpoint/Query/Mutation is generated for a specific primary model.
setIDFieldFor(String, String) - Method in class org.brapi.schematools.core.graphql.options.IdsOptions: Sets the id field name for a specific primary model.
setInputFor(String, boolean) - Method in class org.brapi.schematools.core.graphql.options.AbstractGraphQLQueryOptions: Sets if the Query accepts an input object for a specific primary model
setInputFor(String, boolean) - Method in class org.brapi.schematools.core.openapi.generator.options.ListGetOptions: Sets if the Endpoint has an input for a specific primary model.
setInputFor(BrAPIType, boolean) - Method in class org.brapi.schematools.core.openapi.generator.options.ListGetOptions: Sets if the Endpoint has an input for a specific primary model.
setMergeOneOfType(String, boolean) - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions: Sets if the possible types of a 'OneOf' type are merged into a single type.
setMultipleFor(String, boolean) - Method in class org.brapi.schematools.core.openapi.generator.options.PutOptions: Sets if the PUT Endpoint accepts multiple entities for a specific model
setMultipleFor(BrAPIType, boolean) - Method in class org.brapi.schematools.core.openapi.generator.options.PutOptions: Sets if the PUT Endpoint accepts multiple entities for a specific model
setPagedFor(String, boolean) - Method in class org.brapi.schematools.core.graphql.options.ListQueryOptions: Sets if the Query is paged for a specific primary model
setPagingFor(String, boolean) - Method in class org.brapi.schematools.core.openapi.generator.options.ListGetOptions: Sets if the Endpoint is paged for a specific primary model.
setPagingFor(BrAPIType, boolean) - Method in class org.brapi.schematools.core.openapi.generator.options.ListGetOptions: Sets if the Endpoint is paged for a specific primary model.
setPluralFor(String, String) - Method in class org.brapi.schematools.core.options.AbstractGeneratorOptions: Sets the pluralised name for a specific primary model.
setPluralPropertyNameFor(String, String) - Method in class org.brapi.schematools.core.options.PropertyOptions: Sets the plural property name for a specific primary model.
setPluralPropertyNameFor(BrAPIType, String) - Method in class org.brapi.schematools.core.options.PropertyOptions: Sets the plural property name for a specific primary model.
setPropertyNameFor(String, String) - Method in class org.brapi.schematools.core.options.PropertyOptions: Sets the property name for a specific primary model.
setPropertyNameFor(BrAPIType, String) - Method in class org.brapi.schematools.core.options.PropertyOptions: Sets the property name for a specific primary model.
setSummaryFor(String, String) - Method in class org.brapi.schematools.core.openapi.generator.metadata.AbstractOpenAPIMetadata: Sets the summary for a specific primary model.
setTagFor(String, String) - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions: Sets the tag name for a specific primary model.
setTitleFor(String, String) - Method in class org.brapi.schematools.core.openapi.generator.metadata.OpenAPIGeneratorMetadata: Sets the specification title for a specification generated for a module or class
SingleGetMetadata - Class in org.brapi.schematools.core.openapi.generator.metadata: Provides metadata for the Single Get endpoints
SingleGetMetadata() - Constructor for class org.brapi.schematools.core.openapi.generator.metadata.SingleGetMetadata
SingleGetOptions - Class in org.brapi.schematools.core.openapi.generator.options: Provides options for the generation of Single Get Endpoints
SingleGetOptions() - Constructor for class org.brapi.schematools.core.openapi.generator.options.SingleGetOptions
SingleQueryOptions - Class in org.brapi.schematools.core.graphql.options: Provides options for the generation of Single Queries
SingleQueryOptions() - Constructor for class org.brapi.schematools.core.graphql.options.SingleQueryOptions
startsWithLowerCase(String) - Static method in class org.brapi.schematools.core.utils.StringUtils: Determines if the string starts with an lower case character
startsWithUpperCase(String) - Static method in class org.brapi.schematools.core.utils.StringUtils: Determines if the string starts with an upper case character
STRING - Static variable in class org.brapi.schematools.core.model.BrAPIPrimitiveType: Boolean String Type
StringUtils - Class in org.brapi.schematools.core.utils: Utility class for working with Strings
StringUtils() - Constructor for class org.brapi.schematools.core.utils.StringUtils
SUB_PATH - Enum constant in enum class org.brapi.schematools.core.openapi.generator.LinkType: The property value will be exposed as a separate endpoint
SUB_QUERY - Enum constant in enum class org.brapi.schematools.core.graphql.options.LinkType: The property value will be exposed as a separate sub-query
success(T) - Static method in class org.brapi.schematools.core.response.Response: Creates a successful response for the provided result

T

toLabel(String) - Static method in class org.brapi.schematools.core.utils.StringUtils: Create a label for a property
toList() - Static method in class org.brapi.schematools.core.response.Response: Combines all the results from a stream of Responses of type Response into a single Response that has a result of type List<T>, merging any errors from the individual responses into the returned response.
toLowerCase(String) - Static method in class org.brapi.schematools.core.utils.StringUtils: Makes the whole string lower case
toParameterCase(String) - Static method in class org.brapi.schematools.core.utils.StringUtils: Makes the first letter in the string lower case
toPlural(String) - Static method in class org.brapi.schematools.core.utils.StringUtils: Converts the noun from its singular form to its plural form
toSentenceCase(String) - Static method in class org.brapi.schematools.core.utils.StringUtils: Makes the first letter in the string upper case
toSet() - Static method in class org.brapi.schematools.core.response.Response: Combines all the results a stream of Responses of typeResponse into a single Response that has a result of type Set<T>, merging any errors from the individual responses into the returned response.
toSingular(String) - Static method in class org.brapi.schematools.core.utils.StringUtils: Converts the noun from its plural form to its singular form

U

UpdateMutationOptions - Class in org.brapi.schematools.core.graphql.options: Provides options for the generation of Update Mutations
UpdateMutationOptions() - Constructor for class org.brapi.schematools.core.graphql.options.UpdateMutationOptions

V

valid() - Static method in class org.brapi.schematools.core.validiation.Validation: Get a valid instant of the Validation
Validatable - Interface in org.brapi.schematools.core.validiation: Interface that markers a class that can be validated.
validate() - Method in class org.brapi.schematools.core.graphql.options.AbstractGraphQLOptions
validate() - Method in class org.brapi.schematools.core.graphql.options.AbstractGraphQLQueryOptions
validate() - Method in class org.brapi.schematools.core.graphql.options.CreateMutationOptions
validate() - Method in class org.brapi.schematools.core.graphql.options.DeleteMutationOptions
validate() - Method in class org.brapi.schematools.core.graphql.options.GraphQLGeneratorOptions
validate() - Method in class org.brapi.schematools.core.graphql.options.IdsOptions
validate() - Method in class org.brapi.schematools.core.graphql.options.InputOptions
validate() - Method in class org.brapi.schematools.core.graphql.options.ListQueryOptions
validate() - Method in class org.brapi.schematools.core.graphql.options.MutationTypeOptions
validate() - Method in class org.brapi.schematools.core.graphql.options.PropertiesOptions
validate() - Method in class org.brapi.schematools.core.graphql.options.QueryTypeOptions
validate() - Method in class org.brapi.schematools.core.graphql.options.SearchQueryOptions
validate() - Method in class org.brapi.schematools.core.graphql.options.UpdateMutationOptions
validate() - Method in class org.brapi.schematools.core.markdown.GraphQLMarkdownGeneratorOptions
validate() - Method in class org.brapi.schematools.core.ontmodel.options.OntModelGeneratorOptions
validate() - Method in class org.brapi.schematools.core.openapi.comparator.options.HTMLRenderOptions
validate() - Method in class org.brapi.schematools.core.openapi.comparator.options.JSONRenderOptions
validate() - Method in class org.brapi.schematools.core.openapi.comparator.options.MarkdownRenderOptions
validate() - Method in class org.brapi.schematools.core.openapi.comparator.options.OpenAPIComparatorOptions
validate() - Method in class org.brapi.schematools.core.openapi.generator.options.AbstractOpenAPIOptions
validate() - Method in class org.brapi.schematools.core.openapi.generator.options.ListGetOptions
validate() - Method in class org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions
validate() - Method in class org.brapi.schematools.core.openapi.generator.options.SearchOptions
validate() - Method in class org.brapi.schematools.core.options.AbstractGeneratorSubOptions: Checks if the current options are valid, return a list of errors if the options are not valid
validate() - Method in class org.brapi.schematools.core.options.PropertiesOptions
validate() - Method in class org.brapi.schematools.core.options.PropertyOptions
validate() - Method in interface org.brapi.schematools.core.validiation.Validatable: Checks if the Validatable object is valid, return a list of errors if it is not valid
validate() - Method in class org.brapi.schematools.core.xlsx.options.ValuePropertyOption
validate() - Method in class org.brapi.schematools.core.xlsx.options.XSSFWorkbookGeneratorOptions
Validation - Class in org.brapi.schematools.core.validiation: Provides the results of a validation
Validation() - Constructor for class org.brapi.schematools.core.validiation.Validation
VALIDATION - Enum constant in enum class org.brapi.schematools.core.response.Response.ErrorType: Validation errors
valueOf(String) - Static method in enum class org.brapi.schematools.core.graphql.options.LinkType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.brapi.schematools.core.model.BrAPIRelationshipType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.brapi.schematools.core.openapi.comparator.ComparisonOutputFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.brapi.schematools.core.openapi.generator.LinkType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.brapi.schematools.core.response.Response.ErrorType: Returns the enum constant of this class with the specified name.
ValuePropertyOption - Class in org.brapi.schematools.core.xlsx.options: A value property in a worksheet.
ValuePropertyOption() - Constructor for class org.brapi.schematools.core.xlsx.options.ValuePropertyOption
values() - Static method in enum class org.brapi.schematools.core.graphql.options.LinkType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.brapi.schematools.core.model.BrAPIRelationshipType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.brapi.schematools.core.openapi.comparator.ComparisonOutputFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.brapi.schematools.core.openapi.generator.LinkType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.brapi.schematools.core.response.Response.ErrorType: Returns an array containing the constants of this enum class, in the order they are declared.

W

withResult(Supplier) - Method in class org.brapi.schematools.core.response.Response: If this response has no errors creates a new Response with the result from the supplier, otherwise a new Response with the errors from this resource.
withResult(RESULT) - Method in class org.brapi.schematools.core.response.Response: If this response has no errors creates a new Response with the provided result, otherwise a new Response with the errors from this resource.
writeSchemaToString(GraphQLSchema) - Method in class org.brapi.schematools.core.graphql.GraphQLSchemaParser: Writes the schema to a String.

X

XSSFWorkbookGenerator - Class in org.brapi.schematools.core.xlsx: Generates Excel (xlsx) file(s) for type and their field descriptions from a BrAPI Json Schema.
XSSFWorkbookGenerator(Path) - Constructor for class org.brapi.schematools.core.xlsx.XSSFWorkbookGenerator: Creates a XSSFWorkbookGenerator using a default BrAPISchemaReader and the default OntModelGeneratorOptions.
XSSFWorkbookGenerator(XSSFWorkbookGeneratorOptions, Path) - Constructor for class org.brapi.schematools.core.xlsx.XSSFWorkbookGenerator: Creates a XSSFWorkbookGenerator using a default BrAPISchemaReader and the provided XSSFWorkbookGenerator.
XSSFWorkbookGeneratorOptions - Class in org.brapi.schematools.core.xlsx.options: Options for the GraphQLGenerator.
XSSFWorkbookGeneratorOptions() - Constructor for class org.brapi.schematools.core.xlsx.options.XSSFWorkbookGeneratorOptions

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