Skip to content

Commit 658f9a4

Browse files
henhen
committed
Copying the CLI2 site.xml over, to then be tightened up to be a CLI1 website
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/cli/branches/cli-1.x@756333 13f79535-47bb-0310-9956-ffa450edef68
1 parent ab337e1 commit 658f9a4

11 files changed

Lines changed: 946 additions & 0 deletions

File tree

‎src/site/resources/images/1x1.gif‎

43 Bytes
Loading

‎src/site/resources/images/logo.jpg‎

5.64 KB
Loading

‎src/site/resources/images/logo.png‎

9.92 KB
Loading

‎src/site/resources/images/options.png‎

26.8 KB
Loading

‎src/site/resources/images/svg/commandlines.svg‎

Lines changed: 57 additions & 0 deletions
Loading

‎src/site/resources/images/svg/diagrams-cli2.js‎

Lines changed: 291 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,291 @@
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+
18+
var Option = new Interface("Option");
19+
Option.addMethod("process(...)");
20+
Option.addMethod("canProcess(...)");
21+
Option.addMethod("getTriggers()");
22+
Option.addMethod("getPrefixes()");
23+
Option.addMethod("validate(...)");
24+
Option.addMethod("helpLines(...)");
25+
Option.addMethod("appendUsage(...)");
26+
Option.addMethod("getPreferredName()");
27+
Option.addMethod("getDescription()");
28+
Option.addMethod("getId()");
29+
Option.addMethod("findOption(...)");
30+
31+
var Group = new Interface("Group");
32+
Group.addMethod("appendUsage(...)");
33+
Group.addNote("-a | -b | -c | -d | -e");
34+
35+
var Parent = new Interface("Parent");
36+
Parent.addMethod("processParent(...)");
37+
Parent.addNote("-f <arg1>");
38+
39+
var Argument = new Interface("Argument");
40+
Argument.addMethod("getInitialSeparator()");
41+
Argument.addMethod("processValues(...)");
42+
Argument.addMethod("validate(...)");
43+
Argument.addNote("<arg1> [<arg2> ...]");
44+
45+
var CommandLine = new Interface("CommandLine");
46+
CommandLine.addMethod("hasOption(...)");
47+
CommandLine.addMethod("getOption(...)");
48+
CommandLine.addMethod("getValue(...)");
49+
CommandLine.addMethod("getValues(...)");
50+
CommandLine.addMethod("getSwitch(...)");
51+
CommandLine.addMethod("getProperty(...)");
52+
CommandLine.addMethod("getProperties()");
53+
CommandLine.addMethod("getOptionCount(...)");
54+
CommandLine.addMethod("getOptions()");
55+
CommandLine.addMethod("getOptionTriggers()");
56+
57+
var WriteableCommandLine = new Interface("WriteableCommandLine");
58+
WriteableCommandLine.addMethod("addOption(...)");
59+
WriteableCommandLine.addMethod("addValue(...)");
60+
WriteableCommandLine.addMethod("addSwitch(...)");
61+
WriteableCommandLine.addMethod("addProperty(...)");
62+
WriteableCommandLine.addMethod("looksLikeOption(...)");
63+
64+
65+
66+
67+
68+
var PropertyOption = new Class("PropertyOption");
69+
PropertyOption.addAttribute("optionString");
70+
PropertyOption.addAttribute("description");
71+
PropertyOption.addAttribute("prefixes");
72+
PropertyOption.addNote("-Dproperty=value");
73+
74+
var DefaultOption = new Class("DefaultOption");
75+
DefaultOption.addAttribute("optionString");
76+
DefaultOption.addAttribute("description");
77+
DefaultOption.addAttribute("prefixes");
78+
DefaultOption.addNote("-f (--file, --filelist)");
79+
80+
var Command = new Class("Command");
81+
Command.addAttribute("preferredName");
82+
Command.addAttribute("aliases");
83+
Command.addAttribute("required");
84+
Command.addAttribute("triggers");
85+
Command.addNote("update (up, upd)");
86+
87+
var Switch = new Class("Switch");
88+
Switch.addAttribute("enabledPrefix");
89+
Switch.addAttribute("disabledPrefix");
90+
Switch.addAttribute("preferredName");
91+
Switch.addAttribute("aliases");
92+
Switch.addAttribute("required");
93+
Switch.addAttribute("triggers");
94+
Switch.addAttribute("prefixes");
95+
Switch.addNote("+d|-d (+display|-display)");
96+
97+
var SourceDestArgument = new Class("SourceDestArgument");
98+
SourceDestArgument.addAttribute("preferredName");
99+
SourceDestArgument.addAttribute("aliases");
100+
SourceDestArgument.addAttribute("required");
101+
SourceDestArgument.addAttribute("triggers");
102+
SourceDestArgument.addNote("<src1> <src2> ... <dst>");
103+
104+
105+
106+
107+
var Parser = new Class("Parser");
108+
Parser.addMethod("parse(...)");
109+
Parser.addMethod("parseAndHelp(...)");
110+
Parser.addMethod("setGroup(...)");
111+
Parser.addMethod("setHelpFormatter(...)");
112+
Parser.addMethod("setHelpOption(...)");
113+
Parser.addMethod("setHelpTrigger(...)");
114+
115+
var DefaultingCommandLine = new Class("DefaultingCommandLine");
116+
DefaultingCommandLine.addMethod("appendCommandLine(...)");
117+
DefaultingCommandLine.addMethod("insertCommandLine(...)");
118+
DefaultingCommandLine.addMethod("commandLines()");
119+
120+
var PropertiesCommandLine = new Class("PropertiesCommandLine");
121+
PropertiesCommandLine.addAttribute("properties");
122+
PropertiesCommandLine.addNote("java.util.Properties");
123+
124+
var PreferencesCommandLine = new Class("PreferencesCommandLine");
125+
PreferencesCommandLine.addAttribute("preferences");
126+
PreferencesCommandLine.addNote("java.util.prefs.Preferences");
127+
128+
129+
130+
131+
132+
var ArgumentBuilder = new Class("ArgumentBuilder");
133+
ArgumentBuilder.addMethod("withId(...)");
134+
ArgumentBuilder.addMethod("withName(...)");
135+
ArgumentBuilder.addMethod("withDescription(...)");
136+
ArgumentBuilder.addMethod("withConsumeRemaining(...)");
137+
ArgumentBuilder.addMethod("withValidator(...)");
138+
ArgumentBuilder.addMethod("withMinimum(...)");
139+
ArgumentBuilder.addMethod("withMaximum(...)");
140+
ArgumentBuilder.addMethod("withDefault(...)");
141+
ArgumentBuilder.addMethod("withDefaults(...)");
142+
ArgumentBuilder.addMethod("withInitialSeparator(...)");
143+
ArgumentBuilder.addMethod("withSubsequentSeparator(...)");
144+
ArgumentBuilder.addMethod("create()");
145+
ArgumentBuilder.addMethod("reset()");
146+
147+
var CommandBuilder = new Class("CommandBuilder");
148+
CommandBuilder.addMethod("withId(...)");
149+
CommandBuilder.addMethod("withName(...)");
150+
CommandBuilder.addMethod("withDescription(...)");
151+
CommandBuilder.addMethod("withArgument(...)");
152+
CommandBuilder.addMethod("withChildren(...)");
153+
CommandBuilder.addMethod("withRequired(...)");
154+
CommandBuilder.addMethod("create()");
155+
CommandBuilder.addMethod("reset()");
156+
157+
var DefaultOptionBuilder = new Class("DefaultOptionBuilder");
158+
DefaultOptionBuilder.addMethod("withId(...)");
159+
DefaultOptionBuilder.addMethod("withShortName(...)");
160+
DefaultOptionBuilder.addMethod("withLongName(...)");
161+
DefaultOptionBuilder.addMethod("withDescription(...)");
162+
DefaultOptionBuilder.addMethod("withArgument(...)");
163+
DefaultOptionBuilder.addMethod("withChildren(...)");
164+
DefaultOptionBuilder.addMethod("withRequired(...)");
165+
DefaultOptionBuilder.addMethod("create()");
166+
DefaultOptionBuilder.addMethod("reset()");
167+
DefaultOptionBuilder.addAttribute("shortPrefix");
168+
DefaultOptionBuilder.addAttribute("longPrefix");
169+
DefaultOptionBuilder.addAttribute("burstEnabled");
170+
171+
var DefaultOptionBuilder = new Class("DefaultOptionBuilder");
172+
DefaultOptionBuilder.addMethod("withId(...)");
173+
DefaultOptionBuilder.addMethod("withShortName(...)");
174+
DefaultOptionBuilder.addMethod("withLongName(...)");
175+
DefaultOptionBuilder.addMethod("withDescription(...)");
176+
DefaultOptionBuilder.addMethod("withArgument(...)");
177+
DefaultOptionBuilder.addMethod("withChildren(...)");
178+
DefaultOptionBuilder.addMethod("withRequired(...)");
179+
DefaultOptionBuilder.addMethod("create()");
180+
DefaultOptionBuilder.addMethod("reset()");
181+
182+
var GroupBuilder = new Class("GroupBuilder");
183+
GroupBuilder.addMethod("withName(...)");
184+
GroupBuilder.addMethod("withDescription(...)");
185+
GroupBuilder.addMethod("withOption(...)");
186+
GroupBuilder.addMethod("withMinimum(...)");
187+
GroupBuilder.addMethod("withMaximum(...)");
188+
GroupBuilder.addMethod("create()");
189+
GroupBuilder.addMethod("reset()");
190+
191+
var PatternBuilder = new Class("PatternBuilder");
192+
PatternBuilder.addMethod("withPattern(...)");
193+
PatternBuilder.addMethod("create()");
194+
PatternBuilder.addMethod("reset()");
195+
PatternBuilder.addAttribute("groupBuilder");
196+
PatternBuilder.addAttribute("optionBuilder");
197+
PatternBuilder.addAttribute("argumentBuilder");
198+
199+
var SwitchBuilder = new Class("SwitchBuilder");
200+
SwitchBuilder.addMethod("withId(...)");
201+
SwitchBuilder.addMethod("withName(...)");
202+
SwitchBuilder.addMethod("withDescription(...)");
203+
SwitchBuilder.addMethod("withArgument(...)");
204+
SwitchBuilder.addMethod("withChildren(...)");
205+
SwitchBuilder.addMethod("withRequired(...)");
206+
SwitchBuilder.addMethod("create()");
207+
SwitchBuilder.addMethod("reset()");
208+
SwitchBuilder.addAttribute("enabledPrefix");
209+
SwitchBuilder.addAttribute("disabledPrefix");
210+
211+
212+
213+
var Validator = new Class("Validator");
214+
Validator.addMethod("validate(...)");
215+
216+
var ClassValidator = new Class("ClassValidator");
217+
ClassValidator.addAttribute("classLoader");
218+
ClassValidator.addAttribute("instance");
219+
ClassValidator.addAttribute("loadable");
220+
221+
var DateValidator = new Class("DateValidator");
222+
DateValidator.addAttribute("formats");
223+
DateValidator.addAttribute("minimum");
224+
DateValidator.addAttribute("maximum");
225+
226+
var EnumValidator = new Class("EnumValidator");
227+
EnumValidator.addAttribute("validValues");
228+
229+
var FileValidator = new Class("FileValidator");
230+
FileValidator.addAttribute("directory");
231+
FileValidator.addAttribute("existing");
232+
FileValidator.addAttribute("file");
233+
FileValidator.addAttribute("hidden");
234+
FileValidator.addAttribute("readable");
235+
FileValidator.addAttribute("writable");
236+
237+
var FileValidator = new Class("FileValidator");
238+
FileValidator.addAttribute("format");
239+
FileValidator.addAttribute("minimum");
240+
FileValidator.addAttribute("maximum");
241+
242+
var UrlValidator = new Class("UrlValidator");
243+
UrlValidator.addAttribute("format");
244+
UrlValidator.addAttribute("minimum");
245+
UrlValidator.addAttribute("maximum");
246+
247+
248+
249+
250+
var Comparators = new Class("Comparators");
251+
Comparators.addMethod("chain(...)");
252+
Comparators.addMethod("commandFirst(...)");
253+
Comparators.addMethod("commandLast(...)");
254+
Comparators.addMethod("defaultOptionFirst(...)");
255+
Comparators.addMethod("defaultOptionLast(...)");
256+
Comparators.addMethod("groupFirst(...)");
257+
Comparators.addMethod("groupLast(...)");
258+
Comparators.addMethod("namedFirst(...)");
259+
Comparators.addMethod("namedLast(...)");
260+
Comparators.addMethod("preferredNameFirst(...)");
261+
Comparators.addMethod("preferredNameLast(...)");
262+
Comparators.addMethod("requiredFirst(...)");
263+
Comparators.addMethod("requiredLast(...)");
264+
Comparators.addMethod("switchFirst(...)");
265+
Comparators.addMethod("switchLast(...)");
266+
267+
var HelpFormatter = new Class("HelpFormatter");
268+
HelpFormatter.addMethod("print()");
269+
HelpFormatter.addMethod("printDivider()");
270+
HelpFormatter.addMethod("printException()");
271+
HelpFormatter.addMethod("printFooter()");
272+
HelpFormatter.addMethod("printGutterLeft()");
273+
HelpFormatter.addMethod("printGutterRight()");
274+
HelpFormatter.addMethod("printHeader()");
275+
HelpFormatter.addMethod("printHelp()");
276+
HelpFormatter.addMethod("printUsage()");
277+
HelpFormatter.addAttribute("comparator");
278+
HelpFormatter.addAttribute("displaySettings");
279+
HelpFormatter.addAttribute("divider");
280+
HelpFormatter.addAttribute("exception");
281+
HelpFormatter.addAttribute("footer");
282+
HelpFormatter.addAttribute("fullUsageSettings");
283+
HelpFormatter.addAttribute("group");
284+
HelpFormatter.addAttribute("gutterCenter");
285+
HelpFormatter.addAttribute("gutterLeft");
286+
HelpFormatter.addAttribute("gutterRight");
287+
HelpFormatter.addAttribute("header");
288+
HelpFormatter.addAttribute("lineUsageSettings");
289+
HelpFormatter.addAttribute("pageWidth");
290+
HelpFormatter.addAttribute("printWriter");
291+
HelpFormatter.addAttribute("shellCommand");

0 commit comments

Comments
 (0)