javax.xml.bind.util.ValidationEventCollector Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2003-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.bind.util;
import javax.xml.bind.ValidationEvent;
import javax.xml.bind.ValidationEventHandler;
import java.util.ArrayList;
import java.util.List;
/**
* {@link javax.xml.bind.ValidationEventHandler ValidationEventHandler}
* implementation that collects all events.
*
*
* To use this class, create a new instance and pass it to the setEventHandler
* method of the Validator, Unmarshaller, Marshaller class. After the call to
* validate or unmarshal completes, call the getEvents method to retrieve all
* the reported errors and warnings.
*
* @author
- Kohsuke Kawaguchi, Sun Microsystems, Inc.
- Ryan Shoemaker, Sun Microsystems, Inc.
- Joe Fialli, Sun Microsystems, Inc.
* @see javax.xml.bind.Validator
* @see javax.xml.bind.ValidationEventHandler
* @see javax.xml.bind.ValidationEvent
* @see javax.xml.bind.ValidationEventLocator
* @since 1.6, JAXB 1.0
*/
public class ValidationEventCollector implements ValidationEventHandler
{
private final List events = new ArrayList();
/**
* Return an array of ValidationEvent objects containing a copy of each of
* the collected errors and warnings.
*
* @return
* a copy of all the collected errors and warnings or an empty array
* if there weren't any
*/
public ValidationEvent[] getEvents() {
return events.toArray(new ValidationEvent[events.size()]);
}
/**
* Clear all collected errors and warnings.
*/
public void reset() {
events.clear();
}
/**
* Returns true if this event collector contains at least one
* ValidationEvent.
*
* @return true if this event collector contains at least one
* ValidationEvent, false otherwise
*/
public boolean hasEvents() {
return !events.isEmpty();
}
public boolean handleEvent( ValidationEvent event ) {
events.add(event);
boolean retVal = true;
switch( event.getSeverity() ) {
case ValidationEvent.WARNING:
retVal = true; // continue validation
break;
case ValidationEvent.ERROR:
retVal = true; // continue validation
break;
case ValidationEvent.FATAL_ERROR:
retVal = false; // halt validation
break;
default:
_assert( false,
Messages.format( Messages.UNRECOGNIZED_SEVERITY,
event.getSeverity() ) );
break;
}
return retVal;
}
private static void _assert( boolean b, String msg ) {
if( !b ) {
throw new InternalError( msg );
}
}
}