com.github.kongchen.swagger.docgen.mustache.MustacheItem Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swagger-maven-plugin Show documentation

A maven build plugin which helps you generate API document during build phase

There is a newer version: 3.1.8

package com.github.kongchen.swagger.docgen.mustache;

import com.github.kongchen.swagger.docgen.TypeUtils;
import com.github.kongchen.swagger.docgen.util.Utils;
import com.wordnik.swagger.model.ModelProperty;

public class MustacheItem {
    private String name;

    private String type;

    private String linkType;

    private boolean required;

    private String access;

    private String description;

    private String notes;

    private String allowableValue;

    private int position;

    public MustacheItem(String name, ModelProperty documentationSchema) {

        this.name = name;
        this.type = documentationSchema.type();
        this.linkType = this.type;
        this.description = Utils.getStrInOption(documentationSchema.description());
        this.required = documentationSchema.required();
        this.notes = Utils.getStrInOption(documentationSchema.description());
        this.linkType = TypeUtils.filterBasicTypes(this.linkType);
        this.allowableValue = Utils.allowableValuesToString(documentationSchema.allowableValues());
        this.position = documentationSchema.position();
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public String getLinkType() {
        return linkType;
    }

    public void setLinkType(String linkType) {
        this.linkType = linkType;
    }

    public boolean isRequired() {
        return required;
    }

    public void setRequired(boolean required) {
        this.required = required;
    }

    public String getAccess() {
        return access;
    }

    public void setAccess(String access) {
        this.access = access;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getNotes() {
        return notes;
    }

    public void setNotes(String notes) {
        this.notes = notes;
    }

    public String getAllowableValue() {
        return allowableValue;
    }

    public void setAllowableValue(String allowableValue) {
        this.allowableValue = allowableValue;
    }

    public void setTypeAsArray(String elementType) {
        this.type = TypeUtils.AsArrayType(elementType);
        setLinkType(TypeUtils.filterBasicTypes(elementType));
    }

    public int getPosition() {
        return position;
    }
}