org.sourcelab.buildkite.api.client.request.RequestParameter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of buildkite-api-client Show documentation
A client for Buildkite's rest API
The newest version!
/**
 * Copyright 2023 SourceLab.org https://github.com/SourceLabOrg/Buildkite-Api-Client
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
 * persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package org.sourcelab.buildkite.api.client.request;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;

/**
 * For defining Request Parameters.
 */
public class RequestParameter {
    private String name;
    private Collection values;

    /**
     * Constructor.
     * @param name Name of the parameter.
     * @param values One or more values associated with the parameter.
     */
    public RequestParameter(final String name, final Collection values) {
        this.name = Objects.requireNonNull(name);
        this.values = Collections.unmodifiableCollection(new ArrayList<>(Objects.requireNonNull(values)));
    }

    /**
     * Constructor.
     * @param name Name of the parameter.
     * @param value Value associated with the parameter.
     */
    public RequestParameter(final String name, final String value) {
        this.name = name;
        Objects.requireNonNull(value);

        final List values = new ArrayList<>();
        values.add(value);
        this.values = Collections.unmodifiableCollection(values);
    }

    /**
     * Name of the parameter.
     * @return Name of the parameter.
     */
    public String getName() {
        if (getValues().size() > 1) {
            return name + "[]";
        }
        return name;
    }

    /**
     * Value(s) associated with the parameter.
     * @return Value(s) associated with the parameter.
     */
    public Collection getValues() {
        return values;
    }

    @Override
    public String toString() {
        return "RequestParameter{"
            + "name='" + name + '\''
            + ", values=" + values
            + '}';
    }
}