wow-query/me.ahoo.wow.query.schema/QueryTypeFact

QueryTypeFact

class QueryTypeFact(val kind: QueryValueKind, valueTypes: Set<QueryValueType> = emptySet(), val nullable: Boolean? = null, val required: Boolean? = null, enumValues: List<JsonNode>? = null, val title: String? = null, val description: String? = null, formats: Set<String> = emptySet(), properties: Map<String, QueryTypeFact> = emptyMap(), val items: QueryTypeFact? = null, val additionalProperties: QueryTypeFact? = null, alternatives: List<QueryTypeFact> = emptyList(), val member: QueryMemberFact? = null, omitted: List<QueryMemberFact> = emptyList())

One value of a serialized type.

nullable is null when the source cannot tell; required is null outside an object property. formats are JSON Schema format hints such as date-time. properties are named by their serialized names, even names that are not valid query path segments; additionalProperties is the value of every other key of an open object (a map), or null for none. member is the field or getter that declares this value, null for a nested value, and omitted lists members below this value that the source did not expand, such as a recursive type's members.

Constructors

QueryTypeFact

constructor(kind: QueryValueKind, valueTypes: Set<QueryValueType> = emptySet(), nullable: Boolean? = null, required: Boolean? = null, enumValues: List<JsonNode>? = null, title: String? = null, description: String? = null, formats: Set<String> = emptySet(), properties: Map<String, QueryTypeFact> = emptyMap(), items: QueryTypeFact? = null, additionalProperties: QueryTypeFact? = null, alternatives: List<QueryTypeFact> = emptyList(), member: QueryMemberFact? = null, omitted: List<QueryMemberFact> = emptyList())

Properties

additionalProperties

val additionalProperties: QueryTypeFact?

alternatives

val alternatives: List<QueryTypeFact>

description

val description: String?

enumValues

val enumValues: List<JsonNode>?

formats

val formats: Set<String>

items

val items: QueryTypeFact?

kind

val kind: QueryValueKind

member

val member: QueryMemberFact?

nullable

val nullable: Boolean?

omitted

val omitted: List<QueryMemberFact>

properties

val properties: Map<String, QueryTypeFact>

required

val required: Boolean?

title

val title: String?

valueTypes

val valueTypes: Set<QueryValueType>

Functions

toDeclaration

fun QueryTypeFact.toDeclaration(field: QueryField, contextName: String? = null): QueryFieldDeclaration

The query meaning of a QueryTypeFact at field: its structure as a declaration, with properties that are not valid query path segments left out, standard date formats as Temporal.Date, and member annotations applied.