org.cornutum.tcases.openapi

Class SchemaUtils

java.lang.Object

org.cornutum.tcases.openapi.SchemaUtils

public final class SchemaUtils
extends Object

Defines methods for accessing an OpenAPI Schema object.

Field Summary

Fields

Modifier and Type	Field and Description
static io.swagger.v3.oas.models.media.Schema<?>	EMPTY_SCHEMA A schema that contains no assertions.
static io.swagger.v3.oas.models.media.Schema<?>	FALSE_SCHEMA A schema that will invalidate any instance.
static Set<String>	SCHEMA_TYPES

Method Summary

Modifier and Type	Method and Description
static io.swagger.v3.oas.models.media.Schema<?>	additionalPropertiesSchema(io.swagger.v3.oas.models.media.Schema<?> schema) If the given schema asserts a schema for additional properties, returns the additional properties schema.
static io.swagger.v3.oas.models.media.ArraySchema	asArraySchema(io.swagger.v3.oas.models.media.Schema<?> schema) If the given schema is an ArraySchema instance, returns the casting result.
static io.swagger.v3.oas.models.media.ComposedSchema	asComposedSchema(io.swagger.v3.oas.models.media.Schema<?> schema) If the given schema is a ComposedSchema instance, returns the casting result.
static String	asserts(io.swagger.v3.oas.models.media.Schema<?> schema) Returns a concise description of the assertions made by the given schema.
static String	assertsList(Stream<String> assertions) Returns a description of the given list of assertions.
static io.swagger.v3.oas.models.media.Schema<?>	combineSchemas(OpenApiContext context, io.swagger.v3.oas.models.media.Schema<?> base, io.swagger.v3.oas.models.media.Schema<?> additional) Returns a new schema that validates any instance that satisfies both the base schema and the additional schema.
static io.swagger.v3.oas.models.media.Schema<?>	copySchema(io.swagger.v3.oas.models.media.Schema<?> schema) Returns a new copy of the given schema.
static io.swagger.v3.oas.models.media.Schema<?>	emptySchema() Returns a new empty schema.
static boolean	equalsExtended(io.swagger.v3.oas.models.media.Schema<?> schema1, io.swagger.v3.oas.models.media.Schema<?> schema2, String... extensions) Returns true if the given schemas are equal, comparing values for only the specified extensions.
static boolean	isEmpty(io.swagger.v3.oas.models.media.Schema<?> schema) Returns true if the given schema contains no assertions.
static boolean	isFalse(io.swagger.v3.oas.models.media.Schema<?> schema) Returns true if the given schema is the false schema.
static boolean	isLeafEmpty(io.swagger.v3.oas.models.media.Schema<?> schema) Returns true if this schema contains no leaf assertions.
static boolean	isLeafSchema(io.swagger.v3.oas.models.media.Schema<?> schema) Returns true if this is a basic schema without any boolean combinations of subschemas.
static boolean	isMultipleOf(BigDecimal value, BigDecimal factor) Returns true if the given value is a multiple of the given factor.
static boolean	isNotLeafSchema(io.swagger.v3.oas.models.media.Schema<?> schema) Returns true if this schema asserts any boolean combinations of subschemas.
static boolean	isSchemaType(String type) Returns true if the given schema type is supported by OpenAPI.
static Stream<org.cornutum.regexpgen.RegExpGen>	patternGenerators(io.swagger.v3.oas.models.media.Schema<?> stringSchema) Returns a RegExpGen for each matching pattern required.
static io.swagger.v3.oas.models.media.Schema<?>	resolveSchemaType(io.swagger.v3.oas.models.media.Schema<?> schema) If necessary, updates the type of the given schema based its properties.
static Optional<Object>	schemaExample(io.swagger.v3.oas.models.media.Schema<?> schema) Returns null if no example is defined for the given schema.
static io.swagger.v3.oas.models.media.Schema<?>	toPropertySchema(io.swagger.v3.oas.models.media.Schema<?> schema) Returns the given schema designated as an object property schema.

Methods inherited from class java.lang.Object

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

Field Detail

SCHEMA_TYPES

public static final Set<String> SCHEMA_TYPES

EMPTY_SCHEMA

public static final io.swagger.v3.oas.models.media.Schema<?> EMPTY_SCHEMA

A schema that contains no assertions.

FALSE_SCHEMA

public static final io.swagger.v3.oas.models.media.Schema<?> FALSE_SCHEMA

A schema that will invalidate any instance.

Method Detail

asserts

public static String asserts(io.swagger.v3.oas.models.media.Schema<?> schema)

Returns a concise description of the assertions made by the given schema.

assertsList

public static String assertsList(Stream<String> assertions)

Returns a description of the given list of assertions.

resolveSchemaType

public static io.swagger.v3.oas.models.media.Schema<?> resolveSchemaType(io.swagger.v3.oas.models.media.Schema<?> schema)

If necessary, updates the type of the given schema based its properties. If the type defined for this schema is valid and consistent, returns the updated schema. Otherwise, throws an exception.

isSchemaType

public static boolean isSchemaType(String type)

Returns true if the given schema type is supported by OpenAPI.

asComposedSchema

public static io.swagger.v3.oas.models.media.ComposedSchema asComposedSchema(io.swagger.v3.oas.models.media.Schema<?> schema)

If the given schema is a ComposedSchema instance, returns the casting result. Otherwise, returns null.

asArraySchema

public static io.swagger.v3.oas.models.media.ArraySchema asArraySchema(io.swagger.v3.oas.models.media.Schema<?> schema)

If the given schema is an ArraySchema instance, returns the casting result. Otherwise, returns null.

additionalPropertiesSchema

public static io.swagger.v3.oas.models.media.Schema<?> additionalPropertiesSchema(io.swagger.v3.oas.models.media.Schema<?> schema)

If the given schema asserts a schema for additional properties, returns the additional properties schema. Otherwise, returns null.

toPropertySchema

public static io.swagger.v3.oas.models.media.Schema<?> toPropertySchema(io.swagger.v3.oas.models.media.Schema<?> schema)

Returns the given schema designated as an object property schema.

isLeafSchema

public static boolean isLeafSchema(io.swagger.v3.oas.models.media.Schema<?> schema)

Returns true if this is a basic schema without any boolean combinations of subschemas.

isNotLeafSchema

public static boolean isNotLeafSchema(io.swagger.v3.oas.models.media.Schema<?> schema)

Returns true if this schema asserts any boolean combinations of subschemas.

isLeafEmpty

public static boolean isLeafEmpty(io.swagger.v3.oas.models.media.Schema<?> schema)

Returns true if this schema contains no leaf assertions.

schemaExample

public static Optional<Object> schemaExample(io.swagger.v3.oas.models.media.Schema<?> schema)

Returns null if no example is defined for the given schema. Otherwise, returns Optional.empty() if the schema example value is null. Otherwise, returns the schema example value.

combineSchemas

public static io.swagger.v3.oas.models.media.Schema<?> combineSchemas(OpenApiContext context,
                                                                      io.swagger.v3.oas.models.media.Schema<?> base,
                                                                      io.swagger.v3.oas.models.media.Schema<?> additional)

Returns a new schema that validates any instance that satisfies both the base schema and the additional schema. Throws an exception if a consistent combination is not possible.

isMultipleOf

public static boolean isMultipleOf(BigDecimal value,
                                   BigDecimal factor)

Returns true if the given value is a multiple of the given factor.

patternGenerators

public static Stream<org.cornutum.regexpgen.RegExpGen> patternGenerators(io.swagger.v3.oas.models.media.Schema<?> stringSchema)

Returns a RegExpGen for each matching pattern required.

copySchema

public static io.swagger.v3.oas.models.media.Schema<?> copySchema(io.swagger.v3.oas.models.media.Schema<?> schema)

Returns a new copy of the given schema.

equalsExtended

public static boolean equalsExtended(io.swagger.v3.oas.models.media.Schema<?> schema1,
                                     io.swagger.v3.oas.models.media.Schema<?> schema2,
                                     String... extensions)

Returns true if the given schemas are equal, comparing values for only the specified extensions.

emptySchema

public static io.swagger.v3.oas.models.media.Schema<?> emptySchema()

Returns a new empty schema.

isEmpty

public static boolean isEmpty(io.swagger.v3.oas.models.media.Schema<?> schema)

Returns true if the given schema contains no assertions.

isFalse

public static boolean isFalse(io.swagger.v3.oas.models.media.Schema<?> schema)

Returns true if the given schema is the false schema.