1 package com.lexicalscope.jewel.cli;
2
3 import java.util.List;
4
5 /*
6 * Copyright 2011 Tim Wood
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 */
20
21 /**
22 * BETA - may be altered or removed in future versions
23 *
24 * @author Tim Wood
25 */
26 public interface OptionHelpMessage {
27 void startOptionalOption();
28
29 void startMandatoryOption();
30
31 void longName(List<String> longNames);
32
33 void shortName(List<String> shortName);
34
35 void multiValuedWithCustomPattern(String pattern);
36
37 void multiValuedWithCustomPattern();
38
39 void singleValuedWithCustomPattern(String pattern);
40
41 void singleValued();
42
43 void noValued();
44
45 void endOptionalOption();
46
47 void endOptionalOption(String description);
48
49 void endMandatoryOption();
50
51 void endMandatoryOption(String description);
52 }