com.github.tminglei.swagger.SwaggerExtensions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of binder-swagger-java Show documentation

A framework to bring form-binder-java to swagger

There is a newer version: 0.8.0

package com.github.tminglei.swagger;

import com.github.tminglei.bind.Framework;

/**
 * Extension class to be used to associate extra data to a `com.github.tminglei.bind.Framework.Mapping`
 */
public class SwaggerExtensions implements Framework.Extensible {
    private String in;
    private String desc;
    private String format;
    private Object example;

    public String in() {
        return this.in;
    }
    public SwaggerExtensions in(String in) {
        this.in = in;
        return this;
    }

    public String desc() {
        return this.desc;
    }
    public SwaggerExtensions desc(String desc) {
        this.desc = desc;
        return this;
    }

    public String format() {
        return this.format;
    }
    public SwaggerExtensions format(String format) {
        this.format = format;
        return this;
    }

    public Object example() {
        return this.example;
    }
    public SwaggerExtensions example(Object example) {
        this.example = example;
        return this;
    }

    ///
    public SwaggerExtensions merge(SwaggerExtensions other) {
        SwaggerExtensions merged = this.clone();
        merged.in = other.in;
        return merged;
    }

    @Override
    public SwaggerExtensions clone() {
        SwaggerExtensions clone = new SwaggerExtensions();
        clone.in = this.in;
        clone.desc = this.desc;
        clone.format = this.format;
        clone.example = this.example;
        return clone;
    }

    /// --- static helper methods --------
    public static SwaggerExtensions ext(Framework.Extensible ext) {
        return ext != null ? (SwaggerExtensions) ext : new SwaggerExtensions();
    }
    public static SwaggerExtensions ext(Framework.Mapping mapping) {
        return ext(mapping.options()._ext());
    }
}