File: IntegrityCheckReport.java

package info (click to toggle)
libjpf-java 1.5.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 2,280 kB
  • ctags: 2,079
  • sloc: java: 13,449; xml: 337; sh: 48; makefile: 10
file content (147 lines) | stat: -rw-r--r-- 4,049 bytes parent folder | download | duplicates (4)
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
/*****************************************************************************
 * Java Plug-in Framework (JPF)
 * Copyright (C) 2004-2007 Dmitry Olshansky
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *****************************************************************************/
package org.java.plugin.registry;

import java.util.Collection;
import java.util.Locale;


/**
 * Result of validation performed by registry on all registered plug-ins. This
 * includes dependencies check, parameters check (against parameter definitions)
 * and any other kind of validation.
 * 
 * @version $Id$
 */
public interface IntegrityCheckReport {
    /**
     * @return number of items with severity {@link Severity#ERROR}
     *         in this report
     */
    int countErrors();
    
    /**
     * @return number of items with severity {@link Severity#WARNING}
     *         in this report
     */
    int countWarnings();
    
    /**
     * @return collection of {@link ReportItem} objects
     */
    Collection<ReportItem> getItems();
    
    /**
     * Integrity check report item severity constants.
     * 
     * @version $Id$
     */
    enum Severity {
        /**
         * Integrity check report item severity constant.
         */
        ERROR,
        
        /**
         * Integrity check report item severity constant.
         */
        WARNING,
        
        /**
         * Integrity check report item severity constant.
         */
        INFO
    }
    
    /**
     * Integrity check error constants.
     *
     * @version $Id$
     */
    enum Error {
        /**
         * Integrity check error constant.
         */
        NO_ERROR,
        
        /**
         * Integrity check error constant.
         */
        CHECKER_FAULT,
        
        /**
         * Integrity check error constant.
         */
        MANIFEST_PROCESSING_FAILED,
        
        /**
         * Integrity check error constant.
         */
        UNSATISFIED_PREREQUISITE,
        
        /**
         * Integrity check error constant.
         */
        BAD_LIBRARY,
        
        /**
         * Integrity check error constant.
         */
        INVALID_EXTENSION_POINT,
        
        /**
         * Integrity check error constant.
         */
        INVALID_EXTENSION
    }
    
    /**
     * Integrity check report element. Holds all information about particular
     * check event.
     * @version $Id$
     */
    interface ReportItem {
        /**
         * @return severity code for this report item
         */
        Severity getSeverity();
        
        /**
         * @return source for this report item, can be <code>null</code>
         */
        Identity getSource();
        
        /**
         * @return error code for this report item
         */
        Error getCode();
        
        /**
         * @return message, associated with this report item for the system
         *         default locale
         */
        String getMessage();
        
        /**
         * @param locale locale to get message for
         * @return message, associated with this report item for given locale
         */
        String getMessage(Locale locale);
    }
}