AbstractJsonSchema (Fabric8 :: CRD generator

java.lang.Object
- io.fabric8.crd.generator.AbstractJsonSchema<T,B>

Type Parameters:

T - the concrete type of the generated JSON Schema

B - the concrete type of the JSON Schema builder

Direct Known Subclasses:

JsonSchema, JsonSchema
```
public abstract class AbstractJsonSchema<T,B>
extends Object
```
Encapsulates the common logic supporting OpenAPI schema generation for CRD generation.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ANNOTATION_JSON_ANY_GETTER`
`static String`	`ANNOTATION_JSON_ANY_SETTER`
`static String`	`ANNOTATION_JSON_IGNORE`
`static String`	`ANNOTATION_JSON_PROPERTY`
`static String`	`ANNOTATION_JSON_PROPERTY_DESCRIPTION`
`static String`	`ANNOTATION_NOT_NULL`
`static String`	`ANNOTATION_SCHEMA_FROM`
`protected static io.sundr.model.TypeDef`	`DATE`
`protected static io.sundr.model.TypeRef`	`DATE_REF`
`protected static io.sundr.model.TypeDef`	`DURATION`
`protected static io.sundr.model.TypeRef`	`DURATION_REF`
`protected static io.sundr.model.TypeDef`	`INT_OR_STRING`
`protected static io.sundr.model.TypeRef`	`INT_OR_STRING_REF`
`static String`	`JSON_NODE_TYPE`
`protected static io.sundr.model.TypeDef`	`OBJECT`
`protected static io.sundr.model.TypeRef`	`OBJECT_REF`
`protected static io.sundr.model.TypeRef`	`P_BOOLEAN_REF`
`protected static io.sundr.model.TypeRef`	`P_DOUBLE_REF`
`protected static io.sundr.model.TypeRef`	`P_INT_REF`
`protected static io.sundr.model.TypeRef`	`P_LONG_REF`
`protected static io.sundr.model.TypeDef`	`QUANTITY`
`protected static io.sundr.model.TypeRef`	`QUANTITY_REF`

Constructor Summary

Constructors
Constructor and Description

AbstractJsonSchema()

Constructors
Constructor and Description
`AbstractJsonSchema()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract T`	`addDescription(T schema, String description)`
`abstract void`	`addProperty(io.sundr.model.Property property, B builder, T schema)` Adds the specified property to the specified builder, calling `internalFrom(String, TypeRef)` to create the property schema.
`protected abstract T`	`arrayLikeProperty(T schema)` Builds the schema for array-like properties
`abstract T`	`build(B 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 abstract T`	`enumProperty(com.fasterxml.jackson.databind.JsonNode... enumValues)`
`static String`	`getSchemaTypeFor(io.sundr.model.TypeRef typeRef)`
`T`	`internalFrom(String name, io.sundr.model.TypeRef typeRef)` Builds the specific JSON schema representing the structural schema for the specified property
`protected T`	`internalFrom(io.sundr.model.TypeDef definition, String... ignore)` Creates the JSON schema for the particular `TypeDef`.
`protected abstract T`	`mapLikeProperty(T schema)` Builds the schema for map-like properties
`protected abstract T`	`mappedProperty(io.sundr.model.TypeRef ref)` Builds the schema for specifically handled property types (e.g.
`abstract B`	`newBuilder()` Creates a new specific builder object.
`protected abstract T`	`singleProperty(String typeName)` Builds the schema for standard, simple (e.g.

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

- Field Detail
  - OBJECT
```
protected static final io.sundr.model.TypeDef OBJECT
```
  - QUANTITY
```
protected static final io.sundr.model.TypeDef QUANTITY
```
  - DURATION
```
protected static final io.sundr.model.TypeDef DURATION
```
  - INT_OR_STRING
```
protected static final io.sundr.model.TypeDef INT_OR_STRING
```
  - OBJECT_REF
```
protected static final io.sundr.model.TypeRef OBJECT_REF
```
  - QUANTITY_REF
```
protected static final io.sundr.model.TypeRef QUANTITY_REF
```
  - DURATION_REF
```
protected static final io.sundr.model.TypeRef DURATION_REF
```
  - INT_OR_STRING_REF
```
protected static final io.sundr.model.TypeRef INT_OR_STRING_REF
```
  - DATE
```
protected static final io.sundr.model.TypeDef DATE
```
  - DATE_REF
```
protected static final io.sundr.model.TypeRef DATE_REF
```
  - P_INT_REF
```
protected static final io.sundr.model.TypeRef P_INT_REF
```
  - P_LONG_REF
```
protected static final io.sundr.model.TypeRef P_LONG_REF
```
  - P_DOUBLE_REF
```
protected static final io.sundr.model.TypeRef P_DOUBLE_REF
```
  - P_BOOLEAN_REF
```
protected static final io.sundr.model.TypeRef P_BOOLEAN_REF
```
  - ANNOTATION_JSON_PROPERTY
```
public static final String ANNOTATION_JSON_PROPERTY
```
    See Also:
    
    Constant Field Values
  - ANNOTATION_JSON_PROPERTY_DESCRIPTION
```
public static final String ANNOTATION_JSON_PROPERTY_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - ANNOTATION_JSON_IGNORE
```
public static final String ANNOTATION_JSON_IGNORE
```
    See Also:
    
    Constant Field Values
  - ANNOTATION_JSON_ANY_GETTER
```
public static final String ANNOTATION_JSON_ANY_GETTER
```
    See Also:
    
    Constant Field Values
  - ANNOTATION_JSON_ANY_SETTER
```
public static final String ANNOTATION_JSON_ANY_SETTER
```
    See Also:
    
    Constant Field Values
  - ANNOTATION_NOT_NULL
```
public static final String ANNOTATION_NOT_NULL
```
    See Also:
    
    Constant Field Values
  - ANNOTATION_SCHEMA_FROM
```
public static final String ANNOTATION_SCHEMA_FROM
```
    See Also:
    
    Constant Field Values
  - JSON_NODE_TYPE
```
public static final String JSON_NODE_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractJsonSchema
```
public AbstractJsonSchema()
```
- Method Detail
  - getSchemaTypeFor
```
public static String getSchemaTypeFor(io.sundr.model.TypeRef typeRef)
```
  - internalFrom
```
protected T internalFrom(io.sundr.model.TypeDef definition,
                         String... ignore)
```
    Creates the JSON schema for the particular TypeDef. This is template method where sub-classes are supposed to provide specific implementations of abstract methods.
    
    Parameters:
    
    definition - The definition.
    
    ignore - a potentially empty list of property names to ignore while generating the schema
    
    Returns:
    
    The schema.
  - newBuilder
```
public abstract B newBuilder()
```
    Creates a new specific builder object.
    
    Returns:
    
    a new builder object specific to the CRD generation version
  - addProperty
```
public abstract void addProperty(io.sundr.model.Property property,
                                 B builder,
                                 T schema)
```
    Adds the specified property to the specified builder, calling internalFrom(String, TypeRef) to create the property schema.
    
    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 abstract T build(B 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
    
    Parameters:
    
    builder - the builder used to build the final schema
    
    required - the list of names of required fields
    
    Returns:
    
    the built JSON schema
  - internalFrom
```
public T internalFrom(String name,
                      io.sundr.model.TypeRef typeRef)
```
    Builds the specific JSON schema representing the structural schema for the specified property
    
    Parameters:
    
    name - the name of the property which schema we want to build
    
    typeRef - the type of the property which schema we want to build
    
    Returns:
    
    the structural schema associated with the specified property
  - mappedProperty
```
protected abstract T mappedProperty(io.sundr.model.TypeRef ref)
```
    Builds the schema for specifically handled property types (e.g. intOrString properties)
    
    Parameters:
    
    ref - the type of the specifically handled property
    
    Returns:
    
    the property schema
  - arrayLikeProperty
```
protected abstract T arrayLikeProperty(T schema)
```
    Builds the schema for array-like properties
    
    Parameters:
    
    schema - the schema for the extracted element type for this array-like property
    
    Returns:
    
    the schema for the array-like property
  - mapLikeProperty
```
protected abstract T mapLikeProperty(T schema)
```
    Builds the schema for map-like properties
    
    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 abstract T singleProperty(String typeName)
```
    Builds the schema for standard, simple (e.g. string) property types
    
    Parameters:
    
    typeName - the mapped name of the property type
    
    Returns:
    
    the schema for the property
  - enumProperty
```
protected abstract T enumProperty(com.fasterxml.jackson.databind.JsonNode... enumValues)
```
  - addDescription
```
protected abstract T addDescription(T schema,
                                    String description)
```

Class AbstractJsonSchema<T,B>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OBJECT

QUANTITY

DURATION

INT_OR_STRING

OBJECT_REF

QUANTITY_REF

DURATION_REF

INT_OR_STRING_REF

DATE

DATE_REF

P_INT_REF

P_LONG_REF

P_DOUBLE_REF

P_BOOLEAN_REF

ANNOTATION_JSON_PROPERTY

ANNOTATION_JSON_PROPERTY_DESCRIPTION

ANNOTATION_JSON_IGNORE

ANNOTATION_JSON_ANY_GETTER

ANNOTATION_JSON_ANY_SETTER

ANNOTATION_NOT_NULL

ANNOTATION_SCHEMA_FROM

JSON_NODE_TYPE

Constructor Detail

AbstractJsonSchema

Method Detail

getSchemaTypeFor

internalFrom

newBuilder

addProperty

build

internalFrom

mappedProperty

arrayLikeProperty

mapLikeProperty

singleProperty

enumProperty

addDescription