Package org.alfresco.rest.core.swagger

Class SwaggerModel

java.lang.Object

org.alfresco.rest.core.swagger.SwaggerModel

public class SwaggerModel
extends java.lang.Object

Handles swagger definitions Entry model : swagger.getDefinitions().entrySet()

Author:

Paul Brodner

Constructor Summary

Constructors

Constructor	Description
SwaggerModel(java.util.Map.Entry<java.lang.String,io.swagger.models.Model> model, io.swagger.models.Swagger swagger)

Method Summary

Modifier and Type	Method	Description
boolean	exist()
void	generate()
java.lang.String	getName()
java.lang.String	getNameInTAS()
java.io.File	getPath()
java.util.List<RestModelProperty>	getProperties()
void	setProperties(java.util.List<RestModelProperty> properties)

Methods inherited from class java.lang.Object

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

Constructor Detail

SwaggerModel

public SwaggerModel(java.util.Map.Entry<java.lang.String,io.swagger.models.Model> model,
                    io.swagger.models.Swagger swagger)

Method Detail

exist

public boolean exist()

Returns:

boolean value if file is already generated in TAS, under 'models' package

getPath

public java.io.File getPath()

Returns:

the location of the model in TAS

getName

public java.lang.String getName()

Returns:

original model name as defined in Swagger YAML

getNameInTAS

public java.lang.String getNameInTAS()

Returns:

the name as it will be used in TAS

getProperties

public java.util.List<RestModelProperty> getProperties()

setProperties

public void setProperties(java.util.List<RestModelProperty> properties)

generate

public void generate()
              throws java.io.IOException,
                     freemarker.template.TemplateException

Throws:

java.io.IOException

freemarker.template.TemplateException