org.springframework.oxm.xstream.XStreamUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-oxm Show documentation
Spring Object/XML Mapping abstraction
There is a newer version: 1.5.10
/*
 * Copyright 2006 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.oxm.xstream;

import com.thoughtworks.xstream.alias.CannotResolveClassException;
import com.thoughtworks.xstream.converters.ConversionException;
import com.thoughtworks.xstream.io.StreamException;
import org.springframework.oxm.XmlMappingException;

/**
 * Generic utility methods for working with XStream. Mainly for internal use within the framework.
 *
 * @author Arjen Poutsma
 * @since 1.0.0
 */
public abstract class XStreamUtils {

    /**
     * Converts the given XStream exception to an appropriate exception from the org.springframework.oxm
     * hierarchy.
     * 
     * A boolean flag is used to indicate whether this exception occurs during marshalling or unmarshalling, since
     * XStream itself does not make this distinction in its exception hierarchy.
     *
     * @param ex          XStream exception that occured
     * @param marshalling indicates whether the exception occurs during marshalling (true), or
     *                    unmarshalling (false)
     * @return the corresponding XmlMappingException
     */
    public static XmlMappingException convertXStreamException(Exception ex, boolean marshalling) {
        if (ex instanceof StreamException) {
            if (marshalling) {
                return new XStreamMarshallingFailureException((StreamException) ex);
            }
            else {
                return new XStreamUnmarshallingFailureException((StreamException) ex);
            }
        }
        else if (ex instanceof CannotResolveClassException) {
            if (marshalling) {
                return new XStreamMarshallingFailureException((CannotResolveClassException) ex);
            }
            else {
                return new XStreamUnmarshallingFailureException((CannotResolveClassException) ex);
            }
        }
        else if (ex instanceof ConversionException) {
            if (marshalling) {
                return new XStreamMarshallingFailureException((ConversionException) ex);
            }
            else {
                return new XStreamUnmarshallingFailureException((ConversionException) ex);
            }
        }
        // fallback
        return new XStreamSystemException("Unknown XStream exception: " + ex.getMessage(), ex);
    }

}