1 /**
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.cli2;
18
19 import java.util.Comparator;
20 import java.util.Set;
21
22 /**
23 * Represents a line of help for a particular Option.
24 */
25 public interface HelpLine {
26
27 /**
28 * @return The description of the option
29 */
30 String getDescription();
31
32 /**
33 * @return The level of indentation for this line
34 */
35 int getIndent();
36
37 /**
38 * @return The Option that the help line relates to
39 */
40 Option getOption();
41
42 /**
43 * Builds a usage string for the option using the specified settings and
44 * comparator.
45 *
46 * @param helpSettings
47 * the settings to apply
48 * @param comparator
49 * a comparator to sort options when applicable
50 * @return the usage string
51 */
52 String usage(final Set helpSettings, final Comparator comparator);
53 }