summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/selftests/ESelfTestException.java
blob: b50072e9784c7d1bf6f98cb49c2517b5f49e3a33 (plain)
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
// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
// package statement //
///////////////////////

package com.netscape.certsrv.selftests;


///////////////////////
// import statements //
///////////////////////

import com.netscape.certsrv.base.EBaseException;


//////////////////////
// class definition //
//////////////////////

/**
 * This class implements a self test exception. ESelfTestExceptions
 * are derived from EBaseExceptions in order to allow users
 * to easily do self tests without try-catch clauses.
 *
 * ESelfTestExceptions should be caught by SelfTestSubsystem managers.
 * <P>
 * 
 * @version $Revision$, $Date$
 */
public class ESelfTestException
    extends EBaseException {
    ////////////////////////
    // default parameters //
    ////////////////////////



    ///////////////////////////////////
    // ESelfTestException parameters //
    ///////////////////////////////////

    private static final String SELFTEST_RESOURCES = SelfTestResources.class.getName();


    ///////////////////////////////////////////
    // EBaseException parameters (inherited) //
    ///////////////////////////////////////////

    /* Note that all of the following EBaseException parameters
     * are inherited from the EBaseException class:
     *
     * public Object mParams[];
     */



    /////////////////////
    // default methods //
    /////////////////////

    /**
     * Constructs a self test exception.
     * <P>
     *
     * @param msg exception details
     */
    public ESelfTestException(String msg) {
        super(msg);
    }


    ////////////////////////////////
    // ESelfTestException methods //
    ////////////////////////////////

    /**
     * Returns the bundle file name.
     * <P>
     * @return name of bundle class associated with this exception.
     */
    protected String getBundleName() {
        return SELFTEST_RESOURCES;
    }


    ////////////////////////////////////////
    // EBaseException methods (inherited) //
    ////////////////////////////////////////

    /* Note that all of the following EBaseException methods
     * are inherited from the EBaseException class:
     *
     * public EBaseException( String msgFormat );
     *
     * public EBaseException( String msgFormat, String param );
     *
     * public EBaseException( String msgFormat, Exception param );
     *
     * public EBaseException( String msgFormat, Object params[] );
     *
     * public Object[] getParameters();
     *
     * public String toString();
     *
     * public String toString( Locale locale );
     */
}