org.simpleframework.xml.transform.ClassTransform Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of simple-xml Show documentation
Simple is a high performance XML serialization and configuration framework for Java
The newest version!
/*
 * ClassTransform.java May 2007
 *
 * Copyright (C) 2007, Niall Gallagher 
 *
 * 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.simpleframework.xml.transform;

/**
 * The ClassTransform object is used to transform class
 * values to and from string representations, which will be inserted
 * in the generated XML document as the value place holder. The
 * value must be readable and writable in the same format. Fields
 * and methods annotated with the XML attribute annotation will use
 * this to persist and retrieve the value to and from the XML source.
 *  * 
 *    @Attribute
 *    private Class target;
 *    
 * 
 * As well as the XML attribute values using transforms, fields and
 * methods annotated with the XML element annotation will use this.
 * Aside from the obvious difference, the element annotation has an
 * advantage over the attribute annotation in that it can maintain
 * any references using the CycleStrategy object. 
 * 
 * @author Ben Wolfe
 * @author Niall Gallagher
 */
class ClassTransform implements Transform {
   
   /**
    * This is the string that represents the class for an integer.
    */
   private static final String INTEGER = "int";
   
   /**
    * This is the string that represents the class for a double.
    */
   private static final String DOUBLE = "double";
   
   /**
    * This is the string that represents the class for a float.
    */
   private static final String FLOAT = "float";
   
   /**
    * This is the string that represents the class for a boolean.
    */
   private static final String BOOLEAN = "boolean";
   
   /**
    * This is the string that represents the class for a short.
    */
   private static final String SHORT = "short";
   
   /**
    * This is the string that represents the class for a character.
    */
   private static final String CHARACTER = "char";
   
   /**
    * This is the string that represents the class for a long.
    */
   private static final String LONG = "long";
   
   /**
    * This is the string that represents the class for a byte.
    */
   private static final String BYTE = "byte";
   
   /**
    * This is the string that represents the class for a void.
    */
   private static final String VOID = "void";
  
   /**
    * This method is used to convert the string value given to an
    * appropriate representation. This is used when an object is
    * being deserialized from the XML document and the value for
    * the string representation is required.
    * 
    * @param target this is the string representation of the class
    * 
    * @return this returns an appropriate instanced to be used
    */
   public Class read(String target) throws Exception {                 
      Class type = readPrimitive(target);

      if(type == null) {
         ClassLoader loader = getClassLoader();

         if(loader == null) {
            loader = getCallerClassLoader();
         }
         return loader.loadClass(target);
      }
      return type;
   }

   /**
    * This method is used to convert the string value given to an
    * appropriate representation. This is used when an object is
    * being deserialized from the XML document and the value for
    * the string representation is required.
    * 
    * @param target this is the string representation of the class
    * 
    * @return this returns an appropriate instanced to be used
    */
   private Class readPrimitive(String target) throws Exception {
      if(target.equals(BYTE)) {
         return byte.class;
      }
      if(target.equals(SHORT)) {
         return short.class;
      }
      if(target.equals(INTEGER)) {
         return int.class;
      }
      if(target.equals(LONG)) {
         return long.class;
      }
      if(target.equals(CHARACTER)) {
         return char.class;
      }
      if(target.equals(FLOAT)) {
         return float.class;
      }
      if(target.equals(DOUBLE)) {
         return double.class;
      }
      if(target.equals(BOOLEAN)) {
         return boolean.class;
      }
      if(target.equals(VOID)) {
         return void.class;
      }
      return null;
   }   
   
   /**
    * This method is used to convert the provided value into an XML
    * usable format. This is used in the serialization process when
    * there is a need to convert a field value in to a string so 
    * that that value can be written as a valid XML entity.
    * 
    * @param target this is the value to be converted to a string
    * 
    * @return this is the string representation of the given value
    */
   public String write(Class target) throws Exception {
      return target.getName();
   }

   /**
    * This is used to acquire the caller class loader for this object.
    * Typically this is only used if the thread context class loader
    * is set to null. This ensures that there is at least some class
    * loader available to the strategy to load the class.
    * 
    * @return this returns the loader that loaded this class     
    */
   private ClassLoader getCallerClassLoader() {
      return getClass().getClassLoader();
   }
   
   /**
    * This is used to acquire the thread context class loader. This
    * is the default class loader used by the cycle strategy. When
    * using the thread context class loader the caller can switch the
    * class loader in use, which allows class loading customization.
    * 
    * @return this returns the loader used by the calling thread
    */
   private static ClassLoader getClassLoader() {
      return Thread.currentThread().getContextClassLoader();
   }
}