View Javadoc

1   /*
2    * Copyright 2006 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.springframework.oxm.xstream;
18  
19  import com.thoughtworks.xstream.alias.CannotResolveClassException;
20  import com.thoughtworks.xstream.converters.ConversionException;
21  import com.thoughtworks.xstream.io.StreamException;
22  import org.springframework.oxm.XmlMappingException;
23  
24  /**
25   * Generic utility methods for working with XStream. Mainly for internal use within the framework.
26   *
27   * @author Arjen Poutsma
28   * @since 1.0.0
29   */
30  public abstract class XStreamUtils {
31  
32      /**
33       * Converts the given XStream exception to an appropriate exception from the <code>org.springframework.oxm</code>
34       * hierarchy.
35       * <p/>
36       * A boolean flag is used to indicate whether this exception occurs during marshalling or unmarshalling, since
37       * XStream itself does not make this distinction in its exception hierarchy.
38       *
39       * @param ex          XStream exception that occured
40       * @param marshalling indicates whether the exception occurs during marshalling (<code>true</code>), or
41       *                    unmarshalling (<code>false</code>)
42       * @return the corresponding <code>XmlMappingException</code>
43       */
44      public static XmlMappingException convertXStreamException(Exception ex, boolean marshalling) {
45          if (ex instanceof StreamException) {
46              if (marshalling) {
47                  return new XStreamMarshallingFailureException((StreamException) ex);
48              }
49              else {
50                  return new XStreamUnmarshallingFailureException((StreamException) ex);
51              }
52          }
53          else if (ex instanceof CannotResolveClassException) {
54              if (marshalling) {
55                  return new XStreamMarshallingFailureException((CannotResolveClassException) ex);
56              }
57              else {
58                  return new XStreamUnmarshallingFailureException((CannotResolveClassException) ex);
59              }
60          }
61          else if (ex instanceof ConversionException) {
62              if (marshalling) {
63                  return new XStreamMarshallingFailureException((ConversionException) ex);
64              }
65              else {
66                  return new XStreamUnmarshallingFailureException((ConversionException) ex);
67              }
68          }
69          // fallback
70          return new XStreamSystemException("Unknown XStream exception: " + ex.getMessage(), ex);
71      }
72  
73  }