io.muserver.openapi.ServerObjectBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mu-server Show documentation

A simple but powerful web server framework

There is a newer version: 2.0.3

package io.muserver.openapi;

import java.util.Map;

/**
 * An object representing a Server.
 */
public class ServerObjectBuilder {
    private String url;
    private String description;
    private Map variables;

    /**
     * @param url REQUIRED. A URL to the target host.  This URL supports Server Variables and MAY be relative, to indicate
     * that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will
     * be made when a variable is named in {brackets}.
     * @return The current builder
     */
    public ServerObjectBuilder withUrl(String url) {
        this.url = url;
        return this;
    }

    /**
     * @param description An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.
     * @return The current builder
     */
    public ServerObjectBuilder withDescription(String description) {
        this.description = description;
        return this;
    }

    /**
     * @param variables A map between a variable name and its value. The value is used for substitution in the server's URL template.
     * @return The current builder
     */
    public ServerObjectBuilder withVariables(Map variables) {
        this.variables = variables;
        return this;
    }

    public ServerObject build() {
        return new ServerObject(url, description, variables);
    }

    /**
     * Creates a builder for a {@link ServerObject}
     *
     * @return A new builder
     */
    public static ServerObjectBuilder serverObject() {
        return new ServerObjectBuilder();
    }
}