Package dk.mada.jaxrs.openapi

Interface ParserTypeRef

All Superinterfaces:

Reference, Type

@Immutable
public interface ParserTypeRef
extends Reference

A reference to types used during parsing. This is necessary, because the model may not yet have been populated with DTOs that are defined further down in the schema. When the entire scheme is parsed, these will be dereferenced to proper model TypeRefs.

Method Summary

Modifier and Type	Method	Description
static ParserTypeRef	of(TypeName refTypeName, Validation validation)	Creates a new reference to a type name (a DTO).
static ParserTypeRef	of(Type refType, TypeName refTypeName, Validation validation)	Creates a new reference to a type (a primitive or special type)
Type	refType()	Returns the referenced type - note that this may be unknown.
TypeName	refTypeName()	Returns the referenced type name.
default TypeName	typeName()	Returns the type name.

Methods inherited from interface dk.mada.jaxrs.model.types.Reference

validation

Methods inherited from interface dk.mada.jaxrs.model.types.Type

isBigDecimal, isContainer, isDate, isDateTime, isDto, isEnum, isPlainObject, isPrimitive, isPrimitive, isTime, isUUID, isValidation, isVoid, neededImports, wrapperTypeName

Method Details

of

static ParserTypeRef of(Type refType,
 TypeName refTypeName,
 Validation validation)

Creates a new reference to a type (a primitive or special type)

Parameters:

refType - the type

refTypeName - the type name

validation - the validation information if available

Returns:

a reference to the type

of

static ParserTypeRef of(TypeName refTypeName,
 Validation validation)

Creates a new reference to a type name (a DTO).

Parameters:

refTypeName - the type name

validation - the validation information if available

Returns:

a reference to the type name

refTypeName

TypeName refTypeName()

Returns the referenced type name.

Returns:

the referenced type name

refType

Type refType()

Returns the referenced type - note that this may be unknown.

Specified by:

refType in interface Reference

Returns:

the referenced type - note that this may be unknown

typeName

default TypeName typeName()

Description copied from interface: Type

Returns the type name.

Specified by:

typeName in interface Type

Returns:

the type name