001: /*--
002:
003: Copyright (C) 2002-2005 Adrian Price.
004: All rights reserved.
005:
006: Redistribution and use in source and binary forms, with or without
007: modification, are permitted provided that the following conditions
008: are met:
009:
010: 1. Redistributions of source code must retain the above copyright
011: notice, this list of conditions, and the following disclaimer.
012:
013: 2. Redistributions in binary form must reproduce the above copyright
014: notice, this list of conditions, and the disclaimer that follows
015: these conditions in the documentation and/or other materials
016: provided with the distribution.
017:
018: 3. The names "OBE" and "Open Business Engine" must not be used to
019: endorse or promote products derived from this software without prior
020: written permission. For written permission, please contact
021: adrianprice@sourceforge.net.
022:
023: 4. Products derived from this software may not be called "OBE" or
024: "Open Business Engine", nor may "OBE" or "Open Business Engine"
025: appear in their name, without prior written permission from
026: Adrian Price (adrianprice@users.sourceforge.net).
027:
028: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
029: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
030: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
031: DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
032: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
033: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
034: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
035: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
036: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
037: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
038: POSSIBILITY OF SUCH DAMAGE.
039:
040: For more information on OBE, please see
041: <http://obe.sourceforge.net/>.
042:
043: */
044:
045: package org.obe.client.api.xpdl;
046:
047: import java.io.Serializable;
048: import java.text.MessageFormat;
049: import java.util.Locale;
050: import java.util.ResourceBundle;
051:
052: /**
053: * Holds a validation error as detected by the package validator.
054: *
055: * @author Adrian Price
056: * @see PackageValidator
057: */
058: public final class ValidationError implements Serializable {
059: private static final long serialVersionUID = -3856974003132862868L;
060: public static final int TYPE_WARNING = 0;
061: public static final int TYPE_ERROR = 1;
062: private static final String BUNDLE_NAME = PackageValidatorMessages.class
063: .getName();
064: private static final ResourceBundle _bundle;
065: private final int _type;
066: private final int _msgCode;
067: private final Object[] _args;
068: private final String _msg;
069: private final transient Object _src;
070:
071: static {
072: _bundle = ResourceBundle.getBundle(BUNDLE_NAME, Locale
073: .getDefault());
074: }
075:
076: ValidationError(int type, int msgCode, Object[] args, Object src,
077: String msg) {
078:
079: _type = type;
080: _msgCode = msgCode;
081: _args = args;
082: _src = src;
083: _msg = msg;
084: }
085:
086: /**
087: * Returns a textual description of the error in English. N.B. the text
088: * differs from that supplied by {@link #getLocalizedMessage}, and includes
089: * a representation of the full path to the source of the error.
090: *
091: * @return Error/warning message.
092: */
093: public String getMessage() {
094: return _msg;
095: }
096:
097: /**
098: * Returns a localized textual description of the error.
099: *
100: * @return Error/warning message.
101: */
102: public String getLocalizedMessage() {
103: String msg = _bundle.getString(String.valueOf(_msgCode));
104: return MessageFormat.format(msg, _args);
105: }
106:
107: /**
108: * Returns the array of replaceable arguments for the message.
109: *
110: * @return Message arguments.
111: */
112: public Object[] getMessageArgs() {
113: return _args;
114: }
115:
116: /**
117: * Returns the code for the message.
118: *
119: * @return Message code.
120: */
121: public int getMessageCode() {
122: return _msgCode;
123: }
124:
125: /**
126: * Returns the source workflow object that caused the error.
127: *
128: * @return Error source object.
129: */
130: public Object getSource() {
131: return _src;
132: }
133:
134: /**
135: * Returns the validation error type.
136: *
137: * @return Error type, one of: {@link #TYPE_WARNING}, {@link #TYPE_ERROR}.
138: */
139: public int getType() {
140: return _type;
141: }
142:
143: public String toString() {
144: return String.valueOf(_msgCode) + ": " + _msg
145: + (_src == null ? "" : "; source=" + _src);
146: }
147: }
|