net.jbock.model.Parameter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jbock Show documentation
jbock annotations and utils
The newest version!
package net.jbock.model;

import net.jbock.VarargsParameter;

import java.util.ArrayList;
import java.util.List;
import java.util.Locale;

/**
 * This class is part of the command model.
 * It represents a positional parameter.
 *
 * @see net.jbock.Parameter
 * @see VarargsParameter
 * @see CommandModel
 */
public final class Parameter extends Item {

    private Parameter(
            String paramLabel,
            String descriptionKey,
            List description,
            Multiplicity multiplicity) {
        super(paramLabel, descriptionKey, description, multiplicity);
    }

    /**
     * Creates a builder instance.
     *
     * @param multiplicity multiplicity
     * @return an empty builder
     */
    public static Builder builder(Multiplicity multiplicity) {
        return new Builder(multiplicity);
    }

    /**
     * Builder for a {@code Parameter}.
     */
    public static final class Builder {

        private String paramLabel;
        private String descriptionKey = "";
        private final List description = new ArrayList<>();
        private final Multiplicity multiplicity;

        private Builder(Multiplicity multiplicity) {
            this.multiplicity = multiplicity;
        }

        /**
         * Sets the param label.
         *
         * @see Parameter#paramLabel()
         * @see VarargsParameter#paramLabel()
         * @param paramLabel a non-empty string
         * @return the builder instance
         */
        public Builder withParamLabel(String paramLabel) {
            this.paramLabel = paramLabel;
            return this;
        }

        /**
         * Sets the description key.
         *
         * @see Parameter#descriptionKey()
         * @see VarargsParameter#descriptionKey()
         * @param descriptionKey a string, possibly empty
         * @return the builder instance
         */
        public Builder withDescriptionKey(String descriptionKey) {
            this.descriptionKey = descriptionKey;
            return this;
        }

        /**
         * Adds a line of description text.
         *
         * @see Parameter#description()
         * @see VarargsParameter#description()
         * @param descriptionLine a string, possibly empty
         * @return the builder instance
         */
        public Builder addDescriptionLine(String descriptionLine) {
            this.description.add(descriptionLine);
            return this;
        }

        /**
         * Creates the model for this parameter.
         *
         * @return parameter model
         */
        public Parameter build() {
            return new Parameter(paramLabel, descriptionKey, description, multiplicity);
        }
    }

    @Override
    public String namesOverview() {
        return paramLabel();
    }

    @Override
    public String namesOverviewError() {
        return itemType().name().toLowerCase(Locale.ROOT) + " " + paramLabel();
    }

    @Override
    public ItemType itemType() {
        return ItemType.PARAMETER;
    }
}