001    /**
002     * Copyright 2003-2004 The Apache Software Foundation
003     * Copyright 2005 Stephen McConnell
004     *
005     * Licensed under the Apache License, Version 2.0 (the "License");
006     * you may not use this file except in compliance with the License.
007     * 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 net.dpml.cli;
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     * @author <a href="@PUBLISHER-URL@">@PUBLISHER-NAME@</a>
026     * @version @PROJECT-VERSION@
027     */
028    public interface HelpLine
029    {
030        /**
031         * @return The description of the option
032         */
033        String getDescription();
034    
035        /**
036         * @return The level of indentation for this line
037         */
038        int getIndent();
039    
040        /**
041         * @return The Option that the help line relates to
042         */
043        Option getOption();
044    
045        /**
046         * Builds a usage string for the option using the specified settings and
047         * comparator.
048         * 
049         * @param helpSettings
050         *            the settings to apply
051         * @param comparator
052         *            a comparator to sort options when applicable
053         * @return the usage string
054         */
055        String usage( Set helpSettings, Comparator comparator );
056    }