com.thoughtworks.go.plugin.api.config.Option Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of go-plugin-api Show documentation

The APIs described here are needed for developing plugins for GoCD - A continuous delivery server

There is a newer version: 24.4.0

/*
 * Copyright 2020 ThoughtWorks, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.thoughtworks.go.plugin.api.config;

/**
 * Option could be used to specify metadata for a Property.
 * @param  type for the option value
 */
@Deprecated
//Will be moved to internal scope
public class Option {
    private String name;
    private T value;

    public Option(String name, T value) {
        this.name = name;
        this.value = value;
    }

    /**
     * Sets the value for this option
     * @param value the value to be set for this option
     */
    public void setValue(T value) {
        this.value = value;
    }

    /**
     * Gets value for this option
     * @return value for this option
     */
    public T getValue() {
        return value;
    }

    /**
     * Creates copy of this option
     * @return copy of this option
     */
    public Option copy() {
        return new Option<>(name, value);
    }

    /**
     * Checks if this option has same name as the provided option
     * @param  type for the option value
     * @param option the option for which name equality has to be checked
     * @return true if name matches
     */
    public  boolean hasSameNameAs(Option option) {
        return name.equals(option.name);
    }
}