001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.commons.cli2;
018    
019    import java.util.Comparator;
020    import java.util.Set;
021    
022    /**
023     * Represents a line of help for a particular Option.
024     */
025    public interface HelpLine {
026    
027        /**
028         * @return The description of the option
029         */
030        String getDescription();
031    
032        /**
033         * @return The level of indentation for this line
034         */
035        int getIndent();
036    
037        /**
038         * @return The Option that the help line relates to
039         */
040        Option getOption();
041    
042        /**
043         * Builds a usage string for the option using the specified settings and
044         * comparator.
045         *
046         * @param helpSettings
047         *            the settings to apply
048         * @param comparator
049         *            a comparator to sort options when applicable
050         * @return the usage string
051         */
052        String usage(final Set helpSettings, final Comparator comparator);
053    }