001 /*
002 * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 package javax.xml.bind.helpers;
026
027 import java.text.MessageFormat;
028
029 import javax.xml.bind.ValidationEvent;
030 import javax.xml.bind.ValidationEventLocator;
031
032 /**
033 * Default implementation of the ValidationEvent interface.
034 *
035 * <p>
036 * JAXB providers are allowed to use whatever class that implements
037 * the ValidationEvent interface. This class is just provided for a
038 * convenience.
039 *
040 * @author <ul><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li></ul>
041 * @version $Revision: 1.2 $
042 * @see javax.xml.bind.Validator
043 * @see javax.xml.bind.ValidationEventHandler
044 * @see javax.xml.bind.ValidationEvent
045 * @see javax.xml.bind.ValidationEventLocator
046 * @since JAXB1.0
047 */
048 public class ValidationEventImpl implements ValidationEvent {
049
050 /**
051 * Create a new ValidationEventImpl.
052 *
053 * @param _severity The severity value for this event. Must be one of
054 * ValidationEvent.WARNING, ValidationEvent.ERROR, or
055 * ValidationEvent.FATAL_ERROR
056 * @param _message The text message for this event - may be null.
057 * @param _locator The locator object for this event - may be null.
058 * @throws IllegalArgumentException if an illegal severity field is supplied
059 */
060 public ValidationEventImpl(int _severity, String _message,
061 ValidationEventLocator _locator) {
062
063 this (_severity, _message, _locator, null);
064 }
065
066 /**
067 * Create a new ValidationEventImpl.
068 *
069 * @param _severity The severity value for this event. Must be one of
070 * ValidationEvent.WARNING, ValidationEvent.ERROR, or
071 * ValidationEvent.FATAL_ERROR
072 * @param _message The text message for this event - may be null.
073 * @param _locator The locator object for this event - may be null.
074 * @param _linkedException An optional linked exception that may provide
075 * additional information about the event - may be null.
076 * @throws IllegalArgumentException if an illegal severity field is supplied
077 */
078 public ValidationEventImpl(int _severity, String _message,
079 ValidationEventLocator _locator, Throwable _linkedException) {
080
081 setSeverity(_severity);
082 this .message = _message;
083 this .locator = _locator;
084 this .linkedException = _linkedException;
085 }
086
087 private int severity;
088 private String message;
089 private Throwable linkedException;
090 private ValidationEventLocator locator;
091
092 public int getSeverity() {
093 return severity;
094 }
095
096 /**
097 * Set the severity field of this event.
098 *
099 * @param _severity Must be one of ValidationEvent.WARNING,
100 * ValidationEvent.ERROR, or ValidationEvent.FATAL_ERROR.
101 * @throws IllegalArgumentException if an illegal severity field is supplied
102 */
103 public void setSeverity(int _severity) {
104
105 if (_severity != ValidationEvent.WARNING
106 && _severity != ValidationEvent.ERROR
107 && _severity != ValidationEvent.FATAL_ERROR) {
108 throw new IllegalArgumentException(Messages
109 .format(Messages.ILLEGAL_SEVERITY));
110 }
111
112 this .severity = _severity;
113 }
114
115 public String getMessage() {
116 return message;
117 }
118
119 /**
120 * Set the message field of this event.
121 *
122 * @param _message String message - may be null.
123 */
124 public void setMessage(String _message) {
125 this .message = _message;
126 }
127
128 public Throwable getLinkedException() {
129 return linkedException;
130 }
131
132 /**
133 * Set the linked exception field of this event.
134 *
135 * @param _linkedException Optional linked exception - may be null.
136 */
137 public void setLinkedException(Throwable _linkedException) {
138 this .linkedException = _linkedException;
139 }
140
141 public ValidationEventLocator getLocator() {
142 return locator;
143 }
144
145 /**
146 * Set the locator object for this event.
147 *
148 * @param _locator The locator - may be null.
149 */
150 public void setLocator(ValidationEventLocator _locator) {
151 this .locator = _locator;
152 }
153
154 /**
155 * Returns a string representation of this object in a format
156 * helpful to debugging.
157 *
158 * @see Object#equals(Object)
159 */
160 public String toString() {
161 String s;
162 switch (getSeverity()) {
163 case WARNING:
164 s = "WARNING";
165 break;
166 case ERROR:
167 s = "ERROR";
168 break;
169 case FATAL_ERROR:
170 s = "FATAL_ERROR";
171 break;
172 default:
173 s = String.valueOf(getSeverity());
174 break;
175 }
176 return MessageFormat.format(
177 "[severity={0},message={1},locator={2}]", new Object[] {
178 s, getMessage(), getLocator() });
179 }
180 }
|