io.fabric8.crd.generator.v1

Class JsonSchema

java.lang.Object

io.fabric8.crd.generator.AbstractJsonSchema<io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps,io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder>

io.fabric8.crd.generator.v1.JsonSchema

public class JsonSchema
extends AbstractJsonSchema<io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps,io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder>

Nested Class Summary

Nested classes/interfaces inherited from class io.fabric8.crd.generator.AbstractJsonSchema

AbstractJsonSchema.SchemaPropsOptions

Field Summary

Fields inherited from class io.fabric8.crd.generator.AbstractJsonSchema

ANNOTATION_DEFAULT, ANNOTATION_JSON_ANY_GETTER, ANNOTATION_JSON_ANY_SETTER, ANNOTATION_JSON_IGNORE, ANNOTATION_JSON_PROPERTY, ANNOTATION_JSON_PROPERTY_DESCRIPTION, ANNOTATION_MAX, ANNOTATION_MIN, ANNOTATION_NULLABLE, ANNOTATION_PATTERN, ANNOTATION_PERSERVE_UNKNOWN_FIELDS, ANNOTATION_REQUIRED, ANNOTATION_SCHEMA_FROM, ANNOTATION_SCHEMA_SWAP, ANNOTATION_SCHEMA_SWAPS, ANY_TYPE, DATE, DATE_REF, DURATION, DURATION_REF, INT_OR_STRING, INT_OR_STRING_REF, JSON_NODE_TYPE, OBJECT, OBJECT_REF, P_BOOLEAN_REF, P_DOUBLE_REF, P_FLOAT_REF, P_INT_REF, P_LONG_REF, QUANTITY, QUANTITY_REF

Constructor Summary

Constructors

Constructor and Description
JsonSchema()

Method Summary

Modifier and Type	Method and Description
protected io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps	addDescription(io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps schema, String description)
void	addProperty(io.sundr.model.Property property, io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder builder, io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps schema, AbstractJsonSchema.SchemaPropsOptions options) Adds the specified property to the specified builder, calling AbstractJsonSchema.internalFrom(String, TypeRef) to create the property schema.
protected io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps	arrayLikeProperty(io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps schema) Builds the schema for array-like properties
io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps	build(io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder builder, List<String> required, boolean preserveUnknownFields) Finishes up the process by actually building the final JSON schema based on the provided builder and a potentially empty list of names of fields which should be marked as required
protected io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps	enumProperty(com.fasterxml.jackson.databind.JsonNode... enumValues)
static io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps	from(io.sundr.model.TypeDef definition, String... ignore) Creates the JSON schema for the particular TypeDef.
protected io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps	mapLikeProperty(io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps schema) Builds the schema for map-like properties
protected io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps	mappedProperty(io.sundr.model.TypeRef ref) Builds the schema for specifically handled property types (e.g.
io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder	newBuilder() Creates a new specific builder object.
io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder	newBuilder(String type) Creates a new specific builder object.
protected io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps	singleProperty(String typeName) Builds the schema for standard, simple (e.g.

Methods inherited from class io.fabric8.crd.generator.AbstractJsonSchema

getSchemaTypeFor, internalFrom, internalFrom

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonSchema

public JsonSchema()

Method Detail

from

public static io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps from(io.sundr.model.TypeDef definition,
                                                                                    String... ignore)

Creates the JSON schema for the particular TypeDef.

Parameters:

definition - The definition.

ignore - an optional list of property names to ignore

Returns:

The schema.

newBuilder

public io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder newBuilder()

Description copied from class: AbstractJsonSchema

Creates a new specific builder object.

Specified by:

newBuilder in class AbstractJsonSchema<io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps,io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder>

Returns:

a new builder object specific to the CRD generation version

newBuilder

public io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder newBuilder(String type)

Description copied from class: AbstractJsonSchema

Creates a new specific builder object.

Specified by:

newBuilder in class AbstractJsonSchema<io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps,io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder>

Parameters:

type - the type to be used

Returns:

a new builder object specific to the CRD generation version

addProperty

public void addProperty(io.sundr.model.Property property,
                        io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder builder,
                        io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps schema,
                        AbstractJsonSchema.SchemaPropsOptions options)

Description copied from class: AbstractJsonSchema

Adds the specified property to the specified builder, calling AbstractJsonSchema.internalFrom(String, TypeRef) to create the property schema.

Specified by:

addProperty in class AbstractJsonSchema<io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps,io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder>

Parameters:

property - the property to add to the currently being built schema

builder - the builder representing the schema being built

schema - the built schema for the property being added

build

public io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps build(io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder builder,
                                                                              List<String> required,
                                                                              boolean preserveUnknownFields)

Description copied from class: AbstractJsonSchema

Finishes up the process by actually building the final JSON schema based on the provided builder and a potentially empty list of names of fields which should be marked as required

Specified by:

build in class AbstractJsonSchema<io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps,io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder>

Parameters:

builder - the builder used to build the final schema

required - the list of names of required fields

Returns:

the built JSON schema

arrayLikeProperty

protected io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps arrayLikeProperty(io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps schema)

Description copied from class: AbstractJsonSchema

Builds the schema for array-like properties

Specified by:

arrayLikeProperty in class AbstractJsonSchema<io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps,io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder>

Parameters:

schema - the schema for the extracted element type for this array-like property

Returns:

the schema for the array-like property

mapLikeProperty

protected io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps mapLikeProperty(io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps schema)

Description copied from class: AbstractJsonSchema

Builds the schema for map-like properties

Specified by:

mapLikeProperty in class AbstractJsonSchema<io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps,io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder>

Parameters:

schema - the schema for the extracted element type for the values of this map-like property

Returns:

the schema for the map-like property

singleProperty

protected io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps singleProperty(String typeName)

Description copied from class: AbstractJsonSchema

Builds the schema for standard, simple (e.g. string) property types

Specified by:

singleProperty in class AbstractJsonSchema<io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps,io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder>

Parameters:

typeName - the mapped name of the property type

Returns:

the schema for the property

mappedProperty

protected io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps mappedProperty(io.sundr.model.TypeRef ref)

Description copied from class: AbstractJsonSchema

Builds the schema for specifically handled property types (e.g. intOrString properties)

Specified by:

mappedProperty in class AbstractJsonSchema<io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps,io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder>

Parameters:

ref - the type of the specifically handled property

Returns:

the property schema

enumProperty

protected io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps enumProperty(com.fasterxml.jackson.databind.JsonNode... enumValues)

Specified by:

enumProperty in class AbstractJsonSchema<io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps,io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder>

addDescription

protected io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps addDescription(io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps schema,
                                                                                          String description)

Specified by:

addDescription in class AbstractJsonSchema<io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps,io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder>