/*
 * Copyright 2017-2020 original authors
 *
 * 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
 *
 * https://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 io.micronaut.core.cli;

Represents a command line option.
Author:
Graeme Rocher
Since:
2.0/**
 * Represents a command line option.
 *
 * @author Graeme Rocher
 * @since 2.0
 */
public class Option {

    private String name;
    private String description;

    
Params:
name –        The name
description – The description/**
     * @param name        The name
     * @param description The description
     */
    public Option(String name, String description) {
        if (name == null || name.length() == 0) {
            throw new IllegalArgumentException("illegal option specified");
        }

        this.name = name;
        this.description = description == null ? "" : description;
    }

    
Returns:
The name of the option/**
     * @return The name of the option
     */
    public String getName() {
        return name;
    }

    
Returns:
The description of the option/**
     * @return The description of the option
     */
    public String getDescription() {
        return description;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        Option option = (Option) o;

        return name.equals(option.name);
    }

    @Override
    public int hashCode() {
        return name.hashCode();
    }
}