maven-scr-plugin/src/main/java/org/apache/felix/sandbox/scrplugin/tags/qdox/QDoxJavaClassDescription.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.felix.sandbox.scrplugin.tags.qdox;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.apache.felix.sandbox.scrplugin.tags.JavaClassDescription;
import org.apache.felix.sandbox.scrplugin.tags.JavaClassDescriptorManager;
import org.apache.felix.sandbox.scrplugin.tags.JavaField;
import org.apache.felix.sandbox.scrplugin.tags.JavaMethod;
import org.apache.felix.sandbox.scrplugin.tags.JavaTag;
import org.apache.maven.plugin.MojoExecutionException;

import com.thoughtworks.qdox.model.DocletTag;
import com.thoughtworks.qdox.model.JavaClass;
import com.thoughtworks.qdox.model.JavaSource;
import com.thoughtworks.qdox.model.Type;

/**
 * <code>QDoxJavaClassDescription.java</code>...
 *
 */
public class QDoxJavaClassDescription implements JavaClassDescription {

    protected final JavaClass javaClass;

    protected final JavaClassDescriptorManager manager;

    public QDoxJavaClassDescription(JavaSource source, JavaClassDescriptorManager m) {
        this.javaClass = source.getClasses()[0];
        this.manager = m;
    }

    /**
     * @see org.apache.felix.sandbox.scrplugin.tags.JavaClassDescription#getSuperClass()
     */
    public JavaClassDescription getSuperClass() throws MojoExecutionException {
        final JavaClass parent = this.javaClass.getSuperJavaClass();
        if ( parent != null ) {
            return this.manager.getJavaClassDescription(parent.getFullyQualifiedName());
        }
        return null;
    }

    /**
     * @see org.apache.felix.sandbox.scrplugin.tags.JavaClassDescription#getTagForName(java.lang.String)
     */
    public JavaTag getTagByName(String name) {
        final DocletTag tag = this.javaClass.getTagByName(name);
        if ( tag == null ) {
            return null;
        }
        return new QDoxJavaTag(tag, this);
    }

    /**
     * @see org.apache.felix.sandbox.scrplugin.tags.JavaClassDescription#getName()
     */
    public String getName() {
        return this.javaClass.getFullyQualifiedName();
    }

    /**
     * @see org.apache.felix.sandbox.scrplugin.tags.JavaClassDescription#getTagsByName(java.lang.String, boolean)
     */
    public JavaTag[] getTagsByName(String name, boolean inherited)
    throws MojoExecutionException {
        final DocletTag[] tags = this.javaClass.getTagsByName(name, false);
        JavaTag[] javaTags;
        if ( tags == null || tags.length == 0 ) {
            javaTags = new JavaTag[0];
        } else {
            javaTags = new JavaTag[tags.length];
            for(int i=0; i<tags.length;i++) {
                javaTags[i] = new QDoxJavaTag(tags[i], this);
            }
        }
        if ( inherited && this.getSuperClass() != null ) {
            final JavaTag[] superTags = this.getSuperClass().getTagsByName(name, inherited);
            if ( superTags.length > 0 ) {
                final List list = new ArrayList(Arrays.asList(javaTags));
                list.addAll(Arrays.asList(superTags));
                javaTags = (JavaTag[]) list.toArray(new JavaTag[list.size()]);
            }
        }
        return javaTags;
    }

    /**
     * @see org.apache.felix.sandbox.scrplugin.tags.JavaClassDescription#getFields()
     */
    public JavaField[] getFields() {
        final com.thoughtworks.qdox.model.JavaField fields[] = this.javaClass.getFields();
        if ( fields == null || fields.length == 0 ) {
            return new JavaField[0];
        }
        final JavaField[] f = new JavaField[fields.length];
        for(int i=0; i<fields.length; i++) {
            f[i] = new QDoxJavaField(fields[i], this);
        }
        return f;
    }

    /**
     * @see org.apache.felix.sandbox.scrplugin.tags.JavaClassDescription#getImplementedInterfaces()
     */
    public JavaClassDescription[] getImplementedInterfaces()
    throws MojoExecutionException {
        final JavaClass[] interfaces = this.javaClass.getImplementedInterfaces();
        if ( interfaces == null || interfaces.length == 0 ) {
            return new JavaClassDescription[0];
        }
        final JavaClassDescription[] descs = new JavaClassDescription[interfaces.length];
        for(int i=0;i<interfaces.length; i++) {
            descs[i] = this.manager.getJavaClassDescription(interfaces[i].getFullyQualifiedName());
        }
        return descs;
    }

    /**
     * @see org.apache.felix.sandbox.scrplugin.tags.JavaClassDescription#getMethodBySignature(java.lang.String, java.lang.String[])
     */
    public JavaMethod getMethodBySignature(String name, String[] parameters)
    throws MojoExecutionException {
        Type[] types = null;
        if ( parameters == null || parameters.length == 0 ) {
            types = new Type[0];
        } else {
            types = new Type[parameters.length];
            for(int i=0;i<parameters.length;i++) {
                types[i] = new Type(parameters[i]);
            }
        }
        final com.thoughtworks.qdox.model.JavaMethod m = this.javaClass.getMethodBySignature(name, types);
        if ( m == null ) {
            if ( this.getSuperClass() != null ) {
                return this.getSuperClass().getMethodBySignature(name, parameters);
            }
            return null;
        }
        return new QDoxJavaMethod(m);
    }

    /**
     * @see org.apache.felix.sandbox.scrplugin.tags.JavaClassDescription#getMethods()
     */
    public JavaMethod[] getMethods() {
        final com.thoughtworks.qdox.model.JavaMethod[] methods = this.javaClass.getMethods();
        if ( methods == null || methods.length == 0) {
            return new JavaMethod[0];
        }
        final JavaMethod[] m = new JavaMethod[methods.length];
        for(int i=0;i<methods.length;i++) {
            m[i] = new QDoxJavaMethod(methods[i]);
        }
        return m;
    }

    /**
     * @see org.apache.felix.sandbox.scrplugin.tags.JavaClassDescription#isA(java.lang.String)
     */
    public boolean isA(String type) throws MojoExecutionException {
        final Type qType = new Type(type);
        if ( this.javaClass.isA(type) ) {
            return true;
        }
        final Type[] interfaces = this.javaClass.getImplements();
        if ( interfaces != null ) {
            for(int i=0; i<interfaces.length; i++) {
                if ( interfaces[i].isA(qType) ) {
                    return true;
                }
            }
        }
        if ( this.getSuperClass() != null ) {
            return this.getSuperClass().isA(type);
        }
        return false;
    }

    /**
     * @see org.apache.felix.sandbox.scrplugin.tags.JavaClassDescription#isAbstract()
     */
    public boolean isAbstract() {
        return this.javaClass.isAbstract();
    }

    /**
     * @see org.apache.felix.sandbox.scrplugin.tags.JavaClassDescription#isInterface()
     */
    public boolean isInterface() {
        return this.javaClass.isInterface();
    }

    /**
     * @see org.apache.felix.sandbox.scrplugin.tags.JavaClassDescription#isPublic()
     */
    public boolean isPublic() {
        return this.javaClass.isPublic();
    }
}