public abstract class APITypeModel extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
APITypeModel.Visitor
This "visitor" is used to receive information about a type tree.
|
| Modifier and Type | Field and Description |
|---|---|
protected APIType |
apiType |
protected APITypeSchemaModel |
APITypeSchemaModel |
protected String |
description |
protected String |
displayName |
protected List<String> |
enumValues |
protected String |
example |
protected APITypeModel |
innerType |
protected javax.ws.rs.core.MediaType |
mediaType |
protected List<APIParameterModel> |
parts |
protected APIPrimitiveType |
primitiveType |
protected Boolean |
required |
protected List<APITypeModel> |
unionTypes |
| Modifier | Constructor and Description |
|---|---|
protected |
APITypeModel() |
protected |
APITypeModel(APIPrimitiveType primitiveType) |
| Modifier and Type | Method and Description |
|---|---|
void |
accept(APITypeModel.Visitor visitor)
Traverses an
APITypeModel tree. |
APIType |
getApiType() |
APITypeSchemaModel |
getAPITypeSchemaModel() |
String |
getDescription() |
String |
getDisplayName() |
List<String> |
getEnumValues() |
String |
getExample() |
APITypeModel |
getInnerType() |
abstract APILocation |
getLocation()
Retrieves the location in the API Spec this element was parsed from.
|
javax.ws.rs.core.MediaType |
getMediaType() |
protected javax.ws.rs.core.MediaType |
getMediaTypeForStringOrNull(String mediaType) |
abstract Map<String,APITypeModel> |
getObjectProperties()
Retrieves the types of the properties of an object.
|
List<APIParameterModel> |
getParts() |
APIPrimitiveType |
getPrimitiveType() |
List<APITypeModel> |
getUnionTypes() |
Boolean |
isRequired() |
String |
toString() |
protected APIType apiType
protected javax.ws.rs.core.MediaType mediaType
protected String example
protected APITypeSchemaModel APITypeSchemaModel
protected APIPrimitiveType primitiveType
protected List<APIParameterModel> parts
protected APITypeModel innerType
protected List<APITypeModel> unionTypes
protected String displayName
protected String description
protected Boolean required
protected APITypeModel()
protected APITypeModel(APIPrimitiveType primitiveType)
protected javax.ws.rs.core.MediaType getMediaTypeForStringOrNull(String mediaType)
public APIType getApiType()
public javax.ws.rs.core.MediaType getMediaType()
public String getExample()
public APITypeSchemaModel getAPITypeSchemaModel()
public APIPrimitiveType getPrimitiveType()
public List<APIParameterModel> getParts()
public APITypeModel getInnerType()
public List<APITypeModel> getUnionTypes()
public String getDisplayName()
public String getDescription()
public Boolean isRequired()
public abstract Map<String,APITypeModel> getObjectProperties()
public abstract APILocation getLocation()
public void accept(APITypeModel.Visitor visitor)
APITypeModel tree.
The APITypeModel.Visitor.visit(APITypeModel, String) method is called once for each element in the tree with the type and a
dot-separated path. The root element is also visited (with a path of "").
Copyright © 2023. All rights reserved.