1/*
2 * reserved comment block
3 * DO NOT REMOVE OR ALTER!
4 */
5/*
6 * Licensed to the Apache Software Foundation (ASF) under one or more
7 * contributor license agreements.  See the NOTICE file distributed with
8 * this work for additional information regarding copyright ownership.
9 * The ASF licenses this file to You under the Apache License, Version 2.0
10 * (the "License"); you may not use this file except in compliance with
11 * the License.  You may obtain a copy of the License at
12 *
13 *      http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 */
21
22package com.sun.org.apache.xerces.internal.impl.dv;
23
24import com.sun.org.apache.xerces.internal.utils.SecuritySupport;
25import java.util.ResourceBundle;
26import java.util.PropertyResourceBundle;
27import java.util.MissingResourceException;
28
29/**
30 * Base class for datatype exceptions. For DTD types, the exception can be
31 * created from an error message. For Schema types, it needs an error code
32 * (as defined in Appendix C of the structure spec), plus an array of arguents,
33 * for error message substitution.
34 *
35 * @xerces.internal
36 *
37 * @author Sandy Gao, IBM
38 *
39 */
40public class DatatypeException extends Exception {
41
42    /** Serialization version. */
43    static final long serialVersionUID = 1940805832730465578L;
44
45    // used to store error code and error substitution arguments
46    protected String key;
47    protected Object[] args;
48
49    /**
50     * Create a new datatype exception by providing an error code and a list
51     * of error message substitution arguments.
52     *
53     * @param key  error code
54     * @param args error arguments
55     */
56    public DatatypeException(String key, Object[] args) {
57        super(key);
58        this.key = key;
59        this.args = args;
60    }
61
62    /**
63     * Return the error code
64     *
65     * @return  error code
66     */
67    public String getKey() {
68        return key;
69    }
70
71    /**
72     * Return the list of error arguments
73     *
74     * @return  error arguments
75     */
76    public Object[] getArgs() {
77        return args;
78    }
79
80    /**
81     * Overrides this method to get the formatted&localized error message.
82     *
83     * REVISIT: the system locale is used to load the property file.
84     *          do we want to allow the appilcation to specify a
85     *          different locale?
86     */
87    public String getMessage() {
88        ResourceBundle resourceBundle = null;
89        resourceBundle = SecuritySupport.getResourceBundle("com.sun.org.apache.xerces.internal.impl.msg.XMLSchemaMessages");
90        if (resourceBundle == null)
91            throw new MissingResourceException("Property file not found!", "com.sun.org.apache.xerces.internal.impl.msg.XMLSchemaMessages", key);
92
93        String msg = resourceBundle.getString(key);
94        if (msg == null) {
95            msg = resourceBundle.getString("BadMessageKey");
96            throw new MissingResourceException(msg, "com.sun.org.apache.xerces.internal.impl.msg.XMLSchemaMessages", key);
97        }
98
99        if (args != null) {
100            try {
101                msg = java.text.MessageFormat.format(msg, args);
102            } catch (Exception e) {
103                msg = resourceBundle.getString("FormatFailed");
104                msg += " " + resourceBundle.getString(key);
105            }
106        }
107
108        return msg;
109    }
110}
111