-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
Arguments.java
219 lines (186 loc) · 7.05 KB
/
Arguments.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/*
* Copyright (c) 2002-2016 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.commandline.arguments;
import org.apache.commons.lang3.text.WordUtils;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Optional;
import java.util.function.Function;
import java.util.stream.Collectors;
import org.neo4j.commandline.arguments.common.Database;
import org.neo4j.commandline.arguments.common.MandatoryCanonicalPath;
import org.neo4j.commandline.arguments.common.OptionalCanonicalPath;
/**
* Builder class for constructing a suitable arguments-string for displaying in help messages and alike.
* Some common arguments have convenience functions.
*/
public class Arguments
{
public static final Arguments NO_ARGS = new Arguments();
public static final int LINE_LENGTH = 80;
private final Map<String,NamedArgument> namedArgs;
private final ArrayList<PositionalArgument> positionalArgs;
public Arguments()
{
namedArgs = new LinkedHashMap<>();
positionalArgs = new ArrayList<>();
}
public Arguments withDatabase()
{
return withArgument( new Database() );
}
public Arguments withAdditionalConfig()
{
return withArgument( new OptionalCanonicalPath( "additional-config", "config-file-path", "",
"Configuration file to supply additional configuration in." ) );
}
public Arguments withTo( String description )
{
return withArgument( new MandatoryCanonicalPath( "to", "destination-path", description ) );
}
public Arguments withOptionalPositionalArgument( int position, String value )
{
return withPositionalArgument( new OptionalPositionalArgument( position, value ) );
}
public Arguments withMandatoryPositionalArgument( int position, String value )
{
return withPositionalArgument( new MandatoryPositionalArgument( position, value ) );
}
public Arguments withArgument( NamedArgument namedArgument )
{
namedArgs.put( namedArgument.name(), namedArgument );
return this;
}
public Arguments withPositionalArgument( PositionalArgument arg )
{
positionalArgs.add( arg );
return this;
}
public String usage()
{
StringBuilder sb = new StringBuilder();
if ( !namedArgs.isEmpty() )
{
sb.append( namedArgs.values().stream().map( NamedArgument::usage ).collect( Collectors.joining( " " ) ) );
}
if ( !positionalArgs.isEmpty() )
{
sb.append( " " );
positionalArgs.sort( ( l, r ) -> Integer.compare( l.position(), r.position() ) );
sb.append( positionalArgs.stream().map( a -> a.usage() ).collect( Collectors.joining( " " ) ) );
}
return sb.toString().trim();
}
public String description( String text )
{
String wrappedText = WordUtils.wrap( text, LINE_LENGTH );
if ( namedArgs.isEmpty() )
{
return wrappedText;
}
wrappedText = String.join( "\n\n", wrappedText, "options:" );
//noinspection OptionalGetWithoutIsPresent handled by if-statement above
final int alignLength = namedArgs.values().stream()
.map( a -> a.optionsListing().length() )
.reduce( 0, Integer::max );
return String.join( "\n", wrappedText,
namedArgs.values().stream()
.map( c -> formatArgumentDescription( alignLength, c ) )
.collect( Collectors.joining( "\n" ) ) );
}
public String formatArgumentDescription( final int longestAlignmentLength, final NamedArgument argument )
{
final String left = String.format( " %s", argument.optionsListing() );
final String right;
if ( argument instanceof OptionalNamedArg )
{
right = String.format( "%s [default:%s]", argument.description(),
((OptionalNamedArg) argument).defaultValue() );
}
else
{
right = argument.description();
}
return rightColumnFormatted( left, right, longestAlignmentLength + 5 );
}
public static String rightColumnFormatted( final String leftText, final String rightText, int rightAlignIndex )
{
int rightWidth = Arguments.LINE_LENGTH - rightAlignIndex;
boolean startOnNewLine = false;
if ( rightWidth < 30 )
{
startOnNewLine = true;
rightWidth = 72;
}
final String[] rightLines = WordUtils.wrap( rightText, rightWidth ).split( "\n" );
final String fmt = "%-" + (startOnNewLine ? 6 : rightAlignIndex) + "s%s";
String firstLine = String.format( fmt, leftText, startOnNewLine ? "" : rightLines[0] );
String rest = Arrays.stream( rightLines )
.skip( startOnNewLine ? 0 : 1 )
.map( l -> String.format( fmt, "", l ) )
.collect( Collectors.joining( "\n" ) );
if ( rest.isEmpty() )
{
return firstLine;
}
else
{
return String.join( "\n", firstLine, rest );
}
}
public String parse( String argName, String[] args )
{
if ( namedArgs.containsKey( argName ) )
{
return namedArgs.get( argName ).parse( args );
}
throw new IllegalArgumentException( "No such argument available to be parsed: " + argName );
}
public boolean parseBoolean( String argName, String[] args )
{
return parse( argName, Boolean::parseBoolean, args );
}
public Optional<Path> parseOptionalPath( String argName, String[] args )
{
String p = parse( argName, args );
if ( p.isEmpty() )
{
return Optional.empty();
}
return Optional.of( Paths.get( p ) );
}
public Path parseMandatoryPath( String argName, String[] args )
{
Optional<Path> p = parseOptionalPath( argName, args );
if ( p.isPresent() )
{
return p.get();
}
throw new IllegalArgumentException( String.format( "Missing exampleValue for '%s'", argName ) );
}
public <T> T parse( String argName, Function<String,T> converter, String[] args )
{
return converter.apply( parse( argName, args ) );
}
}