Package com.inductiveautomation.ignition.gateway.dataroutes.openapi

Class SchemaUtil.Builder

java.lang.Object

com.inductiveautomation.ignition.gateway.dataroutes.openapi.SchemaUtil.Builder

Enclosing class:

SchemaUtil

public static class SchemaUtil.Builder
extends Object

A builder for creating JSON schemas.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SchemaUtil.Builder	additionalProperties(Consumer<SchemaUtil.Builder> subSchema)
SchemaUtil.Builder	additionalPropertiesFalse()
final SchemaUtil.Builder	allOf(Consumer<SchemaUtil.Builder>... subSchemas)
final SchemaUtil.Builder	anyOf(Consumer<SchemaUtil.Builder>... subSchemas)
com.inductiveautomation.ignition.common.gson.JsonObject	build()
SchemaUtil.Builder	constant(Object value)	Sets the "const" property of the schema to the given value.
SchemaUtil.Builder	contentEncoding(String contentEncoding)
SchemaUtil.Builder	contribute(Consumer<SchemaUtil.Builder> contributor)
SchemaUtil.Builder	copy(com.inductiveautomation.ignition.common.gson.JsonObject copy)
SchemaUtil.Builder	defaultValue(boolean value)	Sets the default value for the bool type schema.
SchemaUtil.Builder	defaultValue(com.inductiveautomation.ignition.common.gson.JsonElement value)	Sets the default value for the schema.
SchemaUtil.Builder	defaultValue(Number value)	Sets the default value for the number type schema.
SchemaUtil.Builder	description(String description)
SchemaUtil.Builder	descriptionKey(String descriptionKey)
SchemaUtil.Builder	enumeration(Object... values)
SchemaUtil.Builder	example(com.inductiveautomation.ignition.common.gson.JsonElement example)
SchemaUtil.Builder	format(String format)
SchemaUtil.Builder	formFieldSetting(FormSetting key, com.inductiveautomation.ignition.common.gson.JsonElement value)	Adds a UI form field setting for this property.
SchemaUtil.Builder	id(String id)
SchemaUtil.Builder	items(com.inductiveautomation.ignition.common.gson.JsonObject jsonObject)	Shortcut to create an "items" sub schema with the given schema JsonObject.
SchemaUtil.Builder	items(JsonType type)	Shortcut to create an items sub schema with only a type specified
SchemaUtil.Builder	items(Consumer<SchemaUtil.Builder> subSchema)	Sets the required schema for items.
SchemaUtil.Builder	maximum(int maximum, boolean exclusive)
SchemaUtil.Builder	maximum(Number maximum, Boolean exclusive)
SchemaUtil.Builder	maxLength(int maxLength)
SchemaUtil.Builder	minimum(int minimum, boolean exclusive)
SchemaUtil.Builder	minimum(Number minimum, Boolean exclusive)
SchemaUtil.Builder	minLength(int minLength)
SchemaUtil.Builder	nonSecret(boolean isNonSecret)	Marks the most recently added property as non-secret.
SchemaUtil.Builder	not(Consumer<SchemaUtil.Builder> subSchema)
final SchemaUtil.Builder	oneOf(Iterable<Consumer<SchemaUtil.Builder>> subSchemas)
final SchemaUtil.Builder	oneOf(Consumer<SchemaUtil.Builder>... subSchemas)
SchemaUtil.Builder	pattern(String pattern)
SchemaUtil.Builder	property(String name, JsonType type)	Add a basic property to the schema, with just a type identifier.
SchemaUtil.Builder	property(String name, JsonType type, String description)
SchemaUtil.Builder	property(String name, Consumer<SchemaUtil.Builder> subSchema)
SchemaUtil.Builder	propertyNames(Consumer<SchemaUtil.Builder> subSchema)
SchemaUtil.Builder	ref(String ref)
SchemaUtil.Builder	removeProperty(String name)	Removes a property previously added.
SchemaUtil.Builder	required()	Adds the most recently added property to the required list.
SchemaUtil.Builder	title(String title)
SchemaUtil.Builder	type(JsonType type)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

copy

public SchemaUtil.Builder copy(com.inductiveautomation.ignition.common.gson.JsonObject copy)

id

public SchemaUtil.Builder id(String id)

type

public SchemaUtil.Builder type(JsonType type)

title

public SchemaUtil.Builder title(String title)

description

public SchemaUtil.Builder description(String description)

formFieldSetting

public SchemaUtil.Builder formFieldSetting(FormSetting key,
 com.inductiveautomation.ignition.common.gson.JsonElement value)

Adds a UI form field setting for this property. The key is the setting name, and the value is the setting. Form settings are not json-schema standard, but instead are a vendor-specific extension used by Ignition's web-ui form generation.

May be called multiple times to add multiple settings.

descriptionKey

public SchemaUtil.Builder descriptionKey(String descriptionKey)

ref

public SchemaUtil.Builder ref(String ref)

propertyNames

public SchemaUtil.Builder propertyNames(Consumer<SchemaUtil.Builder> subSchema)

property

public SchemaUtil.Builder property(String name,
 JsonType type)

Add a basic property to the schema, with just a type identifier.

property

public SchemaUtil.Builder property(String name,
 JsonType type,
 String description)

property

public SchemaUtil.Builder property(String name,
 Consumer<SchemaUtil.Builder> subSchema)

removeProperty

public SchemaUtil.Builder removeProperty(String name)

Removes a property previously added. Can be useful to conditionally hide properties discovered through reflection.

enumeration

public SchemaUtil.Builder enumeration(Object... values)

constant

public SchemaUtil.Builder constant(Object value)

Sets the "const" property of the schema to the given value. Also invokes type(JsonType) with the type of the value.

nonSecret

public SchemaUtil.Builder nonSecret(boolean isNonSecret)

Marks the most recently added property as non-secret. This is used to pass validation checking for properties the system feels might contain a secret.

Parameters:

isNonSecret - true if the property should be marked as non-secret, false otherwise.

required

public SchemaUtil.Builder required()

Adds the most recently added property to the required list. Usage example:

     builder.property("name", JsonType.STRING).required();
 

defaultValue

public SchemaUtil.Builder defaultValue(com.inductiveautomation.ignition.common.gson.JsonElement value)

Sets the default value for the schema. See the json-schema.org reference

Parameters:

value - The default value.

Returns:

This builder.

defaultValue

public SchemaUtil.Builder defaultValue(boolean value)

Sets the default value for the bool type schema.

Parameters:

value - The default value.

Returns:

This builder.

defaultValue

public SchemaUtil.Builder defaultValue(Number value)

Sets the default value for the number type schema.

Parameters:

value - The default value.

Returns:

This builder.

items

public SchemaUtil.Builder items(Consumer<SchemaUtil.Builder> subSchema)

Sets the required schema for items. Used for when type="array"

items

public SchemaUtil.Builder items(JsonType type)

Shortcut to create an items sub schema with only a type specified

items

public SchemaUtil.Builder items(com.inductiveautomation.ignition.common.gson.JsonObject jsonObject)

Shortcut to create an "items" sub schema with the given schema JsonObject.

Parameters:

jsonObject - the schema to use for the items.

Returns:

this builder.

additionalPropertiesFalse

public SchemaUtil.Builder additionalPropertiesFalse()

additionalProperties

public SchemaUtil.Builder additionalProperties(Consumer<SchemaUtil.Builder> subSchema)

oneOf

@SafeVarargs
public final SchemaUtil.Builder oneOf(Consumer<SchemaUtil.Builder>... subSchemas)

oneOf

public final SchemaUtil.Builder oneOf(Iterable<Consumer<SchemaUtil.Builder>> subSchemas)

allOf

@SafeVarargs
public final SchemaUtil.Builder allOf(Consumer<SchemaUtil.Builder>... subSchemas)

anyOf

@SafeVarargs
public final SchemaUtil.Builder anyOf(Consumer<SchemaUtil.Builder>... subSchemas)

not

public SchemaUtil.Builder not(Consumer<SchemaUtil.Builder> subSchema)

format

public SchemaUtil.Builder format(String format)

contentEncoding

public SchemaUtil.Builder contentEncoding(String contentEncoding)

example

public SchemaUtil.Builder example(com.inductiveautomation.ignition.common.gson.JsonElement example)

minLength

public SchemaUtil.Builder minLength(int minLength)

maxLength

public SchemaUtil.Builder maxLength(int maxLength)

pattern

public SchemaUtil.Builder pattern(String pattern)

minimum

public SchemaUtil.Builder minimum(Number minimum,
 Boolean exclusive)

minimum

public SchemaUtil.Builder minimum(int minimum,
 boolean exclusive)

maximum

public SchemaUtil.Builder maximum(Number maximum,
 Boolean exclusive)

maximum

public SchemaUtil.Builder maximum(int maximum,
 boolean exclusive)

contribute

public SchemaUtil.Builder contribute(Consumer<SchemaUtil.Builder> contributor)

build

public com.inductiveautomation.ignition.common.gson.JsonObject build()