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
|
/**
* Copyright (C) 2010 the original author or authors.
* See the notice.md file distributed with this work for additional
* information regarding copyright ownership.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.beust.jcommander;
import com.beust.jcommander.internal.Lists;
import java.lang.reflect.Field;
import java.util.Collection;
import java.util.List;
import java.util.Locale;
import java.util.ResourceBundle;
import java.util.Set;
public class ParameterDescription {
private Object m_object;
private Parameter m_parameterAnnotation;
private Field m_field;
/** Keep track of whether a value was added to flag an error */
private boolean m_assigned = false;
private ResourceBundle m_bundle;
private String m_description;
private JCommander m_jCommander;
public ParameterDescription(Object object, Parameter annotation, Field field,
ResourceBundle bundle, JCommander jc) {
init(object, annotation, field, bundle, jc);
}
/**
* Find the resource bundle in the annotations.
* @return
*/
private ResourceBundle findResourceBundle(Object o) {
ResourceBundle result = null;
Parameters p = o.getClass().getAnnotation(Parameters.class);
if (p != null && ! isEmpty(p.resourceBundle())) {
result = ResourceBundle.getBundle(p.resourceBundle(), Locale.getDefault());
} else {
com.beust.jcommander.ResourceBundle a = o.getClass().getAnnotation(
com.beust.jcommander.ResourceBundle.class);
if (a != null && ! isEmpty(a.value())) {
result = ResourceBundle.getBundle(a.value(), Locale.getDefault());
}
}
return result;
}
private boolean isEmpty(String s) {
return s == null || "".equals(s);
}
private void init(Object object, Parameter annotation, Field field, ResourceBundle bundle,
JCommander jCommander) {
m_object = object;
m_parameterAnnotation = annotation;
m_field = field;
m_bundle = bundle;
if (m_bundle == null) {
m_bundle = findResourceBundle(object);
}
m_jCommander = jCommander;
m_description = annotation.description();
if (! "".equals(annotation.descriptionKey())) {
if (m_bundle != null) {
m_description = m_bundle.getString(annotation.descriptionKey());
} else {
// System.out.println("Warning: field " + object.getClass() + "." + field.getName()
// + " has a descriptionKey but no bundle was defined with @ResourceBundle, using " +
// "default description:'" + m_description + "'");
}
}
}
public String getDescription() {
return m_description;
}
public Object getObject() {
return m_object;
}
public String getNames() {
StringBuilder sb = new StringBuilder();
for (int i = 0; i < m_parameterAnnotation.names().length; i++) {
if (i > 0) sb.append(", ");
sb.append(m_parameterAnnotation.names()[i]);
}
return sb.toString();
}
public Parameter getParameter() {
return m_parameterAnnotation;
}
public Field getField() {
return m_field;
}
private boolean isMultiOption() {
Class<?> fieldType = m_field.getType();
return fieldType.equals(List.class) || fieldType.equals(Set.class);
}
public void addValue(String value) {
addValue(value, false /* not default */);
}
/**
* @return true if this parameter received a value during the parsing phase.
*/
public boolean wasAssigned() {
return m_assigned;
}
/**
* Add the specified value to the field. First look up any field converter, then
* any type converter, and if we can't find any, throw an exception.
*
* @param markAdded if true, mark this parameter as assigned
*/
public void addValue(String value, boolean isDefault) {
p("Adding " + (isDefault ? "default " : "") + "value:" + value
+ " to parameter:" + m_field.getName());
if (m_assigned && ! isMultiOption()) {
throw new ParameterException("Can only specify option " + m_parameterAnnotation.names()[0]
+ " once.");
}
Class<?> type = m_field.getType();
if (! isDefault) m_assigned = true;
Object convertedValue = m_jCommander.convertValue(this, value);
boolean isCollection = Collection.class.isAssignableFrom(type);
boolean isMainParameter = m_parameterAnnotation.names().length == 0;
try {
if (isCollection) {
@SuppressWarnings("unchecked")
List<Object> l = (List<Object>) m_field.get(m_object);
if (l == null) {
l = Lists.newArrayList();
m_field.set(m_object, l);
}
if (convertedValue instanceof Collection) {
l.addAll((Collection) convertedValue);
} else { // if (isMainParameter || m_parameterAnnotation.arity() > 1) {
l.add(convertedValue);
// } else {
// l.
}
} else {
m_field.set(m_object, convertedValue);
}
}
catch(IllegalAccessException ex) {
ex.printStackTrace();
}
}
public boolean isNumber() {
Class<?> type = m_field.getType();
return type.equals(Integer.class) || type.equals(int.class)
|| type.equals(Long.class) || type.equals(long.class);
}
private void p(String string) {
if (System.getProperty(JCommander.DEBUG_PROPERTY) != null) {
System.out.println("[ParameterDescription] " + string);
}
}
@Override
public String toString() {
return "[ParameterDescription " + m_field.getName() + "]";
}
}
|
