com.mulesoft.connectivity.rest.sdk.internal.webapi.model.type

Class APITypeModel

java.lang.Object

com.mulesoft.connectivity.rest.sdk.internal.webapi.model.type.APITypeModel

Direct Known Subclasses:

AMFTypeModel

public abstract class APITypeModel
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	APITypeModel.Visitor This "visitor" is used to receive information about a type tree.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	APITypeModel()
protected	APITypeModel(APIPrimitiveType primitiveType)

Method Summary

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()

Methods inherited from class java.lang.Object

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

Field Detail

apiType

protected APIType apiType

mediaType

protected javax.ws.rs.core.MediaType mediaType

example

protected String example

enumValues

protected List<String> enumValues

APITypeSchemaModel

protected APITypeSchemaModel APITypeSchemaModel

primitiveType

protected APIPrimitiveType primitiveType

parts

protected List<APIParameterModel> parts

innerType

protected APITypeModel innerType

unionTypes

protected List<APITypeModel> unionTypes

displayName

protected String displayName

description

protected String description

required

protected Boolean required

Constructor Detail

APITypeModel

protected APITypeModel()

APITypeModel

protected APITypeModel(APIPrimitiveType primitiveType)

Method Detail

getMediaTypeForStringOrNull

protected javax.ws.rs.core.MediaType getMediaTypeForStringOrNull(String mediaType)

getApiType

public APIType getApiType()

getMediaType

public javax.ws.rs.core.MediaType getMediaType()

getExample

public String getExample()

getEnumValues

public List<String> getEnumValues()

getAPITypeSchemaModel

public APITypeSchemaModel getAPITypeSchemaModel()

getPrimitiveType

public APIPrimitiveType getPrimitiveType()

getParts

public List<APIParameterModel> getParts()

getInnerType

public APITypeModel getInnerType()

getUnionTypes

public List<APITypeModel> getUnionTypes()

getDisplayName

public String getDisplayName()

getDescription

public String getDescription()

isRequired

public Boolean isRequired()

getObjectProperties

public abstract Map<String,APITypeModel> getObjectProperties()

Retrieves the types of the properties of an object.

Returns:

a map from property name to property type

getLocation

public abstract APILocation getLocation()

Retrieves the location in the API Spec this element was parsed from.

toString

public String toString()

Overrides:

toString in class Object

accept

public void accept(APITypeModel.Visitor visitor)

Traverses an 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 "").