001/*
002 * Copyright 2012-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.cli.command.options;
018
019import java.util.Set;
020
021/**
022 * Help for a specific option.
023 *
024 * @author Phillip Webb
025 */
026public interface OptionHelp {
027
028        /**
029         * Returns the set of options that are mutually synonymous.
030         * @return the options
031         */
032        Set<String> getOptions();
033
034        /**
035         * Returns usage help for the option.
036         * @return the usage help
037         */
038        String getUsageHelp();
039
040}