Mercurial > lada > lada-server

annotate src/main/java/de/intevation/lada/validation/ValidationException.java @ 366:567ce7697fc7 0.5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Code documentation.
author Raimund Renkert <rrenkert@intevation.de>
date Tue, 10 Sep 2013 15:55:54 +0200
parents 92affd9467f8
children 183f8116d9a6
rev   line source
63
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
1 package de.intevation.lada.validation;
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
2
116
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
3 import java.util.HashMap;
63
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
4 import java.util.Map;
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
5
68
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
6 /**
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
7 * Exception used for validation errors.
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
8 *
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
9 * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a>
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
10 */
63
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
11 public class ValidationException
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
12 extends Exception
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
13 {
68
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
14 /**
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
15 * Errors saved in this exception.
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
16 */
63
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
17 private Map<String, Integer> errors;
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
18
68
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
19 /**
116
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
20 * Warnings saved in this exception.
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
21 */
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
22 private Map<String, Integer> warnings;
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
23
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
24 /**
68
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
25 * Do not allow an empty ValidationException object.
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
26 */
63
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
27 private ValidationException() {
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
28 }
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
29
68
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
30 /**
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
31 * Create a new instance with errors.
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
32 *
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
33 * @param errors
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
34 */
63
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
35 public ValidationException(Map<String, Integer> errors) {
68
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
36 this();
63
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
37 this.errors = errors;
116
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
38 this.warnings = new HashMap<String, Integer>();
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
39 }
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
40
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
41 /**
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
42 * Create a new instance with errors and warnings.
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
43 *
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
44 * @param errors
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
45 */
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
46 public ValidationException(
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
47 Map<String, Integer> errors,
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
48 Map<String, Integer> warnings
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
49 ) {
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
50 this();
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
51 this.errors = errors;
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
52 this.warnings = warnings;
63
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
53 }
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
54
68
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
55 /**
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
56 * Getter for the errors.
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
57 *
366
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 116
diff changeset
58 * @return the errors
68
9e34b7e872f9 Documentation and minor code cosmetics/renamings.
Raimund Renkert <rrenkert@intevation.de>
parents: 63
diff changeset
59 */
63
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
60 public Map<String, Integer> getErrors() {
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
61 return errors;
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
62 }
116
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
63
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
64 /**
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
65 * Getter for the warnings.
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
66 *
366
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 116
diff changeset
67 * @return the warnings
116
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
68 */
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
69 public Map<String, Integer> getWarnings() {
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
70 return warnings;
92affd9467f8 Added warnings to ValidationException.
Raimund Renkert <rrenkert@intevation.de>
parents: 68
diff changeset
71 }
63
7dc8a1579e39 New validator interface and validation exception.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
72 }
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)