/
gettingstarted.pot
354 lines (317 loc) · 12.6 KB
/
gettingstarted.pot
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# SOME DESCRIPTIVE TITLE.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: http://bugs.kde.org\n"
"POT-Creation-Date: 2011-11-14 10:37+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <kde-i18n-doc@kde.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#. Tag: title
#: gettingstarted.xml:24
#, no-c-format
msgid "Getting started"
msgstr ""
#. Tag: para
#: gettingstarted.xml:26
#, no-c-format
msgid "This chapter will show you how to get started with Hibernate Validator, the reference implementation (RI) of Bean Validation. For the following quickstart you need:"
msgstr ""
#. Tag: para
#: gettingstarted.xml:32
#, no-c-format
msgid "A JDK >= 5"
msgstr ""
#. Tag: ulink
#: gettingstarted.xml:36
#, no-c-format
msgid "Apache Maven"
msgstr ""
#. Tag: para
#: gettingstarted.xml:40
#, no-c-format
msgid "An Internet connection (Maven has to download all required libraries)"
msgstr ""
#. Tag: para
#: gettingstarted.xml:45
#, no-c-format
msgid ""
"A properly configured remote repository. Add the following to your <filename>settings.xml</filename>: <example id=\"example-jboss-maven-url\"> <title>Configuring the JBoss Maven repository</title> <programlisting><repositories>\n"
" <repository>\n"
" <id>jboss-public-repository-group</id>\n"
" <url>https://repository.jboss.org/nexus/content/groups/public-jboss</url>\n"
" <releases>\n"
" <enabled>true</enabled>\n"
" </releases>\n"
" <snapshots>\n"
" <enabled>true</enabled>\n"
" </snapshots>\n"
" </repository>\n"
"</repositories> </programlisting> </example>More information about <filename>settings.xml</filename> can be found in the <ulink url=\"http://maven.apache.org/ref/2.0.8/maven-settings/settings.html\">Maven Local Settings Model</ulink>."
msgstr ""
#. Tag: para
#: gettingstarted.xml:58
#, no-c-format
msgid ""
"Hibernate Validator uses JAXB for XML parsing. JAXB is part of the Java Class Library since Java 6 which means that if you run Hibernate Validator with Java 5 you will have to add additional JAXB dependencies. Using Maven you have to add the following dependencies:<programlisting><dependency>\n"
" <groupId>javax.xml.bind</groupId>\n"
" <artifactId>jaxb-api</artifactId>\n"
" <version>2.2</version>\n"
"</dependency>\n"
"<dependency>\n"
" <groupId>com.sun.xml.bind</groupId>\n"
" <artifactId>jaxb-impl</artifactId>\n"
" <version>2.1.12</version>\n"
"</dependency>\n"
"</programlisting> if you are using the SourceForge package you find the necessary libraries in the <filename>lib/jdk5</filename> directory. In case you are not using the XML configuration you can also disable it explicitly by calling <methodname>Configuration.ignoreXmlConfiguration()</methodname> during <classname>ValidationFactory</classname> creation. In this case the JAXB dependencies are not needed."
msgstr ""
#. Tag: title
#: gettingstarted.xml:71
#, no-c-format
msgid "Setting up a new Maven project"
msgstr ""
#. Tag: para
#: gettingstarted.xml:73
#, no-c-format
msgid "Start by creating new Maven project using the Maven archetype plugin as follows:"
msgstr ""
#. Tag: title
#: gettingstarted.xml:77
#, no-c-format
msgid "Using Maven's archetype plugin to create a sample project using Hibernate Validator"
msgstr ""
#. Tag: programlisting
#: gettingstarted.xml:80
#, no-c-format
msgid ""
"mvn archetype:generate -DarchetypeGroupId=org.hibernate \\\n"
" -DarchetypeArtifactId=hibernate-validator-quickstart-archetype \\\n"
" -DarchetypeVersion=&version; \\\n"
" -DarchetypeRepository=http://repository.jboss.org/nexus/content/groups/public-jboss/ \\\n"
" -DgroupId=com.mycompany \\\n"
" -DartifactId=hv-quickstart"
msgstr ""
#. Tag: para
#: gettingstarted.xml:83
#, no-c-format
msgid "Maven will create your project in the directory hv-quickstart. Change into this directory and run:"
msgstr ""
#. Tag: programlisting
#: gettingstarted.xml:86
#, no-c-format
msgid "mvn test"
msgstr ""
#. Tag: para
#: gettingstarted.xml:86
#, no-c-format
msgid "Maven will compile the example code and run the implemented unit tests. Let's have a look at the actual code."
msgstr ""
#. Tag: para
#: gettingstarted.xml:91
#, no-c-format
msgid "From version 4.2.0.Beta2, the maven command <command>mvn archetype:create</command> will be no longer supported and will fail. You should use the command described in the above listing. If you want more details, look at <ulink url=\"http://maven.apache.org/archetype/maven-archetype-plugin/\"> Maven Archetype plugin</ulink> page."
msgstr ""
#. Tag: title
#: gettingstarted.xml:101
#, no-c-format
msgid "Applying constraints"
msgstr ""
#. Tag: para
#: gettingstarted.xml:103
#, no-c-format
msgid "Open the project in the IDE of your choice and have a look at the class <classname>Car</classname>:"
msgstr ""
#. Tag: title
#: gettingstarted.xml:107
#, no-c-format
msgid "Class Car annotated with constraints"
msgstr ""
#. Tag: programlisting
#: gettingstarted.xml:109
#, no-c-format
msgid ""
"package com.mycompany;\n"
"\n"
"import javax.validation.constraints.Min;\n"
"import javax.validation.constraints.NotNull;\n"
"import javax.validation.constraints.Size;\n"
"\n"
"public class Car {\n"
"\n"
" @NotNull\n"
" private String manufacturer;\n"
"\n"
" @NotNull\n"
" @Size(min = 2, max = 14)\n"
" private String licensePlate;\n"
"\n"
" @Min(2)\n"
" private int seatCount;\n"
" \n"
" public Car(String manufacturer, String licencePlate, int seatCount) {\n"
" this.manufacturer = manufacturer;\n"
" this.licensePlate = licencePlate;\n"
" this.seatCount = seatCount;\n"
" }\n"
"\n"
" //getters and setters ...\n"
"}"
msgstr ""
#. Tag: para
#: gettingstarted.xml:112
#, no-c-format
msgid "<classname>@NotNull</classname>, <classname>@Size</classname> and <classname>@Min</classname> are so-called constraint annotations, that we use to declare constraints, which shall be applied to the fields of a <classname>Car</classname> instance:"
msgstr ""
#. Tag: para
#: gettingstarted.xml:119
#, no-c-format
msgid "<property>manufacturer</property> shall never be null"
msgstr ""
#. Tag: para
#: gettingstarted.xml:123
#, no-c-format
msgid "<property>licensePlate</property> shall never be null and must be between 2 and 14 characters long"
msgstr ""
#. Tag: para
#: gettingstarted.xml:128
#, no-c-format
msgid "<property>seatCount</property> shall be at least 2."
msgstr ""
#. Tag: title
#: gettingstarted.xml:134
#, no-c-format
msgid "Validating constraints"
msgstr ""
#. Tag: para
#: gettingstarted.xml:136
#, no-c-format
msgid "To perform a validation of these constraints, we use a <classname>Validator</classname> instance. Let's have a look at the <classname>CarTest</classname> class:"
msgstr ""
#. Tag: title
#: gettingstarted.xml:141
#, no-c-format
msgid "Class CarTest showing validation examples"
msgstr ""
#. Tag: programlisting
#: gettingstarted.xml:143
#, no-c-format
msgid ""
"package com.mycompany;\n"
"\n"
"import static org.junit.Assert.*;\n"
"\n"
"import java.util.Set;\n"
"\n"
"import javax.validation.ConstraintViolation;\n"
"import javax.validation.Validation;\n"
"import javax.validation.Validator;\n"
"import javax.validation.ValidatorFactory;\n"
"\n"
"import org.junit.BeforeClass;\n"
"import org.junit.Test;\n"
"\n"
"public class CarTest {\n"
"\n"
" private static Validator validator;\n"
"\n"
" @BeforeClass\n"
" public static void setUp() {\n"
" ValidatorFactory factory = Validation.buildDefaultValidatorFactory();\n"
" validator = factory.getValidator();\n"
" }\n"
"\n"
" @Test\n"
" public void manufacturerIsNull() {\n"
" Car car = new Car(null, \"DD-AB-123\", 4);\n"
"\n"
" Set<ConstraintViolation<Car>> constraintViolations =\n"
" validator.validate(car);\n"
"\n"
" assertEquals(1, constraintViolations.size());\n"
" assertEquals(\"may not be null\", constraintViolations.iterator().next().getMessage());\n"
" }\n"
"\n"
" @Test\n"
" public void licensePlateTooShort() {\n"
" Car car = new Car(\"Morris\", \"D\", 4);\n"
"\n"
" Set<ConstraintViolation<Car>> constraintViolations = \n"
" validator.validate(car);\n"
"\n"
" assertEquals(1, constraintViolations.size());\n"
" assertEquals(\"size must be between 2 and 14\", constraintViolations.iterator().next().getMessage());\n"
" }\n"
" \n"
" @Test\n"
" public void seatCountTooLow() {\n"
" Car car = new Car(\"Morris\", \"DD-AB-123\", 1);\n"
"\n"
" Set<ConstraintViolation<Car>> constraintViolations =\n"
" validator.validate(car);\n"
"\n"
" assertEquals(1, constraintViolations.size());\n"
" assertEquals(\"must be greater than or equal to 2\", constraintViolations.iterator().next().getMessage());\n"
" }\n"
"\n"
" @Test\n"
" public void carIsValid() {\n"
" Car car = new Car(\"Morris\", \"DD-AB-123\", 2);\n"
"\n"
" Set<ConstraintViolation<Car>> constraintViolations =\n"
" validator.validate(car);\n"
"\n"
" assertEquals(0, constraintViolations.size());\n"
" }\n"
"}"
msgstr ""
#. Tag: para
#: gettingstarted.xml:146
#, no-c-format
msgid "In the <methodname>setUp()</methodname> method we get a <classname>Validator</classname> instance from the <classname>ValidatorFactory</classname>. A <classname>Validator</classname> instance is thread-safe and may be reused multiple times. For this reason we store it as field of our test class. We can use the <classname>Validator</classname> now to validate the different car instances in the test methods."
msgstr ""
#. Tag: para
#: gettingstarted.xml:154
#, no-c-format
msgid "The <methodname>validate()</methodname> method returns a set of <classname>ConstraintViolation</classname> instances, which we can iterate in order to see which validation errors occurred. The first three test methods show some expected constraint violations:"
msgstr ""
#. Tag: para
#: gettingstarted.xml:161
#, no-c-format
msgid "The <classname>@NotNull</classname> constraint on manufacturer is violated in <methodname>manufacturerIsNull()</methodname>"
msgstr ""
#. Tag: para
#: gettingstarted.xml:166
#, no-c-format
msgid "The <classname>@Size</classname> constraint on licensePlate is violated in <methodname>licensePlateTooShort()</methodname>"
msgstr ""
#. Tag: para
#: gettingstarted.xml:171
#, no-c-format
msgid "The <classname>@Min</classname> constraint on seatCount is violated in <methodname>seatCountTooLow()</methodname>"
msgstr ""
#. Tag: para
#: gettingstarted.xml:176
#, no-c-format
msgid "If the object validates successfully, <methodname>validate()</methodname> returns an empty set."
msgstr ""
#. Tag: para
#: gettingstarted.xml:179
#, no-c-format
msgid "Note that we only use classes from the package <package>javax.validation</package> from the Bean Validation API. As we don't reference any classes of the RI directly, it would be no problem to switch to another implementation of the API, should that need arise."
msgstr ""
#. Tag: title
#: gettingstarted.xml:187
#, no-c-format
msgid "Where to go next?"
msgstr ""
#. Tag: para
#: gettingstarted.xml:189
#, no-c-format
msgid "That concludes our 5 minute tour through the world of Hibernate Validator. Continue exploring the code examples or look at further examples referenced in <xref linkend=\"validator-further-reading\"/>. To deepen your understanding of Hibernate Validator just continue reading <xref linkend=\"validator-usingvalidator\"/>. In case your application has specific validation requirements have a look at <xref linkend=\"validator-customconstraints\"/>."
msgstr ""