/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 2003 The Apache Software Foundation.  All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
*
* 2. 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.
*
* 3. The end-user documentation included with the redistribution,
*    if any, must include the following acknowledgment:
*       "This product includes software developed by the
*        Apache Software Foundation (http://www.apache.org/)."
*    Alternately, this acknowledgment may appear in the software itself,
*    if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" must
*    not be used to endorse or promote products derived from this
*    software without prior written permission. For written
*    permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache
*    XMLBeans", nor may "Apache" appear in their name, without prior
*    written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR
* ITS 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 2003 BEA Systems
* Inc., <http://www.bea.com/>. For more information on the Apache Software
* Foundation, please see <http://www.apache.org/>.
*/

package org.apache.xmlbeans.impl.jam.internal.reflect;

import org.apache.xmlbeans.impl.jam.*;
import org.apache.xmlbeans.impl.jam.internal.BaseJElement;
import org.apache.xmlbeans.impl.jam.internal.JClassHelper;
import org.apache.xmlbeans.impl.jam.internal.JPropertyImpl;
import org.apache.xmlbeans.impl.jam.internal.PrimitiveJClass;

import java.io.StringWriter;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.*;

/**
 * Javadoc-backed implementation of JClass.
 *
 * @author Patrick Calahan <pcal@bea.com>
 */
public class RClass extends BaseJElement implements JClass {

  // ========================================================================
  // Variables

  private Map mWrapperMap = new HashMap();
  private Class mClass;
  private JClassHelper mHelper;//this class is dumb
  private JClassLoader mLoader;

  // ========================================================================
  // Constructors

  public RClass(Class c, JClassLoader loader) {
    mLoader = loader;
    mClass = c;
    mHelper = new JClassHelper(this);
  }

  // ========================================================================
  // JElement implementation

  public JElement getParent() {
    return mHelper.getParent();
  }

  public JElement[] getChildren() {
    return mHelper.getChildren();
  }

  public String getSimpleName() {
    String out = getQualifiedName();
    int lastDot = out.lastIndexOf('.');
    return (lastDot == -1) ? out : out.substring(lastDot + 1);
  }

  public String getQualifiedName() {
    if (!isArray()) {
      return mClass.getName();
    } else {
      StringWriter out = new StringWriter();
      out.write(getArrayComponentType().getQualifiedName());
      int dim = getArrayDimensions();
      for (int i = 0; i < dim; i++) out.write("[]");
      return out.toString();
    }
  }

  // ========================================================================
  // BaseJElement implementation

  /**
   * We can't implement this until JSR175 is here.
   */
  protected void getLocalAnnotations(Collection out) {
  }

  /**
   * We can't ever implement this.
   */
  protected void getLocalComments(Collection out) {
  }

  // ========================================================================
  // JClass implementation

  public JClassLoader getClassLoader() {
    return mLoader;
  }

  public JClass forName(String fd) throws ClassNotFoundException {
    return mLoader.loadClass(fd);
  }

  public JClass getSuperclass() {
    if (isObject() || isInterface() || isPrimitive()) {
      return null;
    } else {
      return getClassSafely(mClass.getSuperclass().getName(), mLoader);
    }
  }

  public JClass[] getInterfaces() {
    return getClasses(mClass.getInterfaces());
  }

  public JField[] getFields() {
    return mHelper.getAllFields();
  }

  public JField[] getDeclaredFields() {
    return getFields(mClass.getDeclaredFields());
  }

  public JConstructor[] getConstructors() {
    return getConstructors(mClass.getConstructors());
  }

  public JMethod[] getMethods() {
    return mHelper.getAllMethods();
  }

  public JMethod[] getDeclaredMethods() {
    return getMethods(mClass.getDeclaredMethods());
  }

  public JPackage getContainingPackage() {
    String pkgName;
    if (mClass.getPackage() != null) {
      pkgName = mClass.getPackage().getName();
    } else {
      // If the package isn't already defined in the classloader,
      // let's not go defining new packages - just figure it out the
      // hard way.
      pkgName = !isArray() ? getQualifiedName() :
              getArrayComponentType().getQualifiedName();
      int lastDot = pkgName.lastIndexOf(".");
      if (lastDot != -1 && lastDot < pkgName.length() - 1) {
        pkgName = pkgName.substring(0, lastDot);
      }
    }
    return mLoader.getPackage(pkgName);
  }

  public boolean isInterface() {
    return mClass.isInterface();
  }

  public boolean isPrimitive() {
    return (PrimitiveJClass.getPrimitiveClass(mClass) != null);
  }

  public boolean isVoid() {
    return mClass.getName().equals("void");
  }

  public boolean isObject() {
    return mClass == Object.class;
  }

  public boolean isAbstract() {
    return Modifier.isAbstract(mClass.getModifiers());
  }

  public boolean isArray() {
    return mClass.isArray();
  }

  public JClass getArrayComponentType() {
    if (mClass.getComponentType() == null) {
      return null;
    } else {
      Class c = mClass.getComponentType();
      while (c.getComponentType() != null) c = c.getComponentType();
      return getClassSafely(c.getName(), mLoader);
    }
  }


  public int getArrayDimensions() {
    int out = 0;
    Class c = mClass;
    while ((c = c.getComponentType()) != null) out++;
    return out;
  }

  public String getFieldDescriptor() {
    return mClass.getName();
  }

  public JClass[] getClasses() {
    return getClasses(mClass.getClasses());
  }

  public boolean isAssignableFrom(JClass clazz) {
    return mHelper.isAssignableFrom(clazz);
  }

  public boolean isStatic() {
    return Modifier.isStatic(mClass.getModifiers());
  }

  public boolean isFinal() {
    return Modifier.isFinal(mClass.getModifiers());
  }

  public JProperty[] getProperties() {
    //REVIEW maybe we should retrieve the BeanInfo in order to get
    //properties
    return JPropertyImpl.getProperties(this);
  }

  // ========================================================================
  // JMember implementation

  public JClass getContainingClass() {
    return getClassSafely(mClass.getDeclaringClass().getName(), mLoader);
  }

  public boolean isProtected() {
    return Modifier.isProtected(mClass.getModifiers());
  }

  public boolean isPublic() {
    return Modifier.isPublic(mClass.getModifiers());
  }

  public boolean isPrivate() {
    return Modifier.isPrivate(mClass.getModifiers());
  }

  public boolean isPackagePrivate() {
    return !isPublic() && !isProtected() && !isPrivate();
  }

  public int getModifiers() {
    return mClass.getModifiers();
  }

  public JSourcePosition getSourcePosition() {
    return null;
  }

  // ========================================================================
  // Object implementation

  public boolean equals(Object o) {
    if (o instanceof JClass) {
      return ((JClass) o).getFieldDescriptor().equals(getFieldDescriptor());
    }
    return false;
  }

  public int hashCode() {
    return getFieldDescriptor().hashCode();
  }

  // ========================================================================
  // Private methods

  private JField[] getFields(Field[] fields) {
    List list = new ArrayList();
    for (int i = 0; i < fields.length; i++) {
      list.add(getField(fields[i]));
    }
    JField[] out = new JField[list.size()];
    list.toArray(out);
    return out;
  }

  private JMethod[] getMethods(Method[] methods) {
    List list = new ArrayList();
    for (int i = 0; i < methods.length; i++) {
      list.add(getMethod(methods[i]));
    }
    JMethod[] out = new JMethod[list.size()];
    list.toArray(out);
    return out;
  }

  private JConstructor[] getConstructors(Constructor[] constructors) {
    List list = new ArrayList();
    for (int i = 0; i < constructors.length; i++) {
      list.add(getConstructor(constructors[i]));
    }
    JConstructor[] out = new JConstructor[list.size()];
    list.toArray(out);
    return out;
  }

  private JField getField(Field f) {
    JField out = (JField) mWrapperMap.get(f);
    if (out == null) mWrapperMap.put(f, out = new RField(f, mLoader));
    return out;
  }

  private JMethod getMethod(Method f) {
    JMethod out = (JMethod) mWrapperMap.get(f);
    if (out == null) mWrapperMap.put(f, out = new RMethod(f, mLoader));
    return out;
  }

  private JConstructor getConstructor(Constructor f) {
    JConstructor out = (JConstructor) mWrapperMap.get(f);
    if (out == null) mWrapperMap.put(f, out = new RConstructor(f, mLoader));
    return out;
  }

  private JClass[] getClasses(Class[] c) {
    return getClasses(c, mLoader);
  }

  // ========================================================================
  // Package utility methods

  /*package*/
  static JClass[] getClasses(Class[] c, JClassLoader loader) {
    if (c == null) return null;
    JClass[] out = new JClass[c.length];
    for (int i = 0; i < out.length; i++) {
      out[i] = getClassSafely(c[i].getName(), loader);
    }
    return out;
  }
}