1 package com.lexicalscope.jewel.cli;
2
3 /*
4 * Copyright 2011 Tim Wood
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
19 /**
20 * BETA - may be altered or removed in future versions
21 *
22 * @author Tim Wood
23 */
24 public interface HelpMessage {
25 void noUsageInformation();
26
27 void hasUsageInformation(String applicationName);
28
29 void hasUsageInformation();
30
31 void hasOnlyOptionalOptions();
32
33 void hasSomeMandatoryOptions();
34
35 void hasUnparsedMultiValuedOption(String valueName);
36
37 void hasUnparsedOption(String valueName);
38
39 void startOfOptions();
40
41 OptionHelpMessage option();
42
43 void endOfOptions();
44 }