io.github.amayaframework.router.QueryParameter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of amaya-router Show documentation

Amaya Router

There is a newer version: 1.0.1

package io.github.amayaframework.router;

/**
 * A class that represents a query parameter descriptor.
 */
public final class QueryParameter extends Parameter {
    Boolean required;

    /**
     * Constructs an {@link QueryParameter} instance with given name, type and requirement flag.
     *
     * @param name     the specified query parameter name, must be non-null
     * @param required the specified requirement flag, may be null
     * @param type     the specified query parameter type, may be null
     */
    public QueryParameter(String name, Boolean required, String type) {
        super(name, type);
        this.required = required;
    }

    /**
     * Checks if this parameter is required.
     *
     * @return boolean value if set, null otherwise
     */
    public Boolean isRequired() {
        return required;
    }
}