1 /*
2 Copyright (c) 2005, Vilmantas Baranauskas
3 All rights reserved.
4
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions are met:
7 * Redistributions of source code must retain the above copyright notice,
8 this list of conditions and the following disclaimer.
9 * Redistributions in binary form must reproduce the above copyright notice,
10 this list of conditions and the following disclaimer in the documentation
11 and/or other materials provided with the distribution.
12 * The names of its contributors may not be used to endorse or promote
13 products derived from this software without specific prior written
14 permission.
15
16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 POSSIBILITY OF SUCH DAMAGE.
27 */
28 package org.sovt;
29
30 /***
31 * This interface is used to create and access result of SOVT validation or
32 * inspection.
33 * <p>
34 * There are two types of messages: messages and failures. Messages do not make
35 * validation result invalid, failures do.
36 * <p>
37 * Result contains messages. Messages can be set on result itself (general
38 * messages) or for a specific key (specific messages) so they can be
39 * distinguished later.
40 *
41 * @author Vilmantas Baranauskas
42 */
43 public interface ValidationResult {
44
45 void addMessage(String msg);
46
47 /***
48 * Add message for a key.
49 *
50 * @param key Key of message.
51 * @param msg message.
52 */
53 void addMessage(String key, String msg);
54
55 void fail(String msg);
56
57 /***
58 * Add failure for a key.
59 *
60 * @param key Key of fail message.
61 * @param msg Fail message.
62 */
63 void fail(String key, String msg);
64
65 boolean isValid();
66
67 /***
68 * Returns true if there is NO error for a key.
69 *
70 * @param key Key to check.
71 * @return true if there is NO error for a key.
72 */
73 boolean isValid(String key);
74
75 String toString();
76
77 }