typedescription.java

对xml很好的java处理引擎,编译中绑定xml

/*
Copyright (c) 2006, Dennis M. Sosnoski
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 * Neither the name of JiBX nor the names of its contributors may be used
   to endorse or promote products derived from this software without specific
   prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

package org.jibx.typeinfo;

/**
 * Base class for representing type descriptions. This provides the default
 * implementations for methods overridden by specific subclasses.
 */
public abstract class TypeDescription
{
    /** Empty field description array. */
    public static final FieldDescription[] EMPTY_FIELD_ARRAY = {};
    
    /** Empty method description array. */
    public static final MethodDescription[] EMPTY_METHOD_ARRAY = {};
    
    /** Type descriptor. */
    private final String m_descriptor;
    
    /**
     * Constructor.
     * 
     * @param dtor type descriptor
     */
    protected TypeDescription(String dtor) {
        m_descriptor = dtor;
    }
    
    /**
     * Check if type is an array.
     * 
     * @return <code>true</code> if array, <code>false</code> if not
     */
    public boolean isArray() {
        return false;
    }
    
    /**
     * Get array item type.
     * 
     * @return item type
     * @throws IllegalStateException if not an array type
     */
    public TypeDescription getArrayItemType() {
        throw new IllegalStateException("Not an array");
    }
    
    /**
     * Check if type is a primitive.
     * 
     * @return <code>true</code> if primitive, <code>false</code> if not
     */
    public boolean isPrimitive() {
        return false;
    }
    
    /**
     * Get fields defined by type.
     * 
     * @return array of fields
     */
    public FieldDescription[] getFields() {
        return EMPTY_FIELD_ARRAY;
    }
    
    /**
     * Get methods defined by type.
     * 
     * @return array of methods
     */
    public MethodDescription[] getMethods() {
        return EMPTY_METHOD_ARRAY;
    }
    
    /**
     * Get descriptor for type.
     * 
     * @return descriptor
     */
    public String getDescriptor() {
        return m_descriptor;
    }
    
    /**
     * Check for equality. 
     * 
     * @param obj comparison object
     * @return <code>true</code> if equal, <code>false</code> if not
     */
    public boolean equals(Object obj) {
        if (obj == this) {
            return true;
        } else if (obj instanceof TypeDescription) {
            return m_descriptor.equals(((TypeDescription)obj).m_descriptor);
        } else {
            return false;
        }
    }
    
    /**
     * Get hash code. This just returns the hash code of the descriptor.
     * 
     * @return hash code
     */
    public int hashCode() {
        return m_descriptor.hashCode();
    }
    
    /**
     * Get type description in external form. Subclasses must implement this
     * method.
     * 
     * @return external description
     */
    public abstract String toString();
}