com.thoughtworks.qdox.model.impl.DefaultJavaExecutable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qdox Show documentation
QDox is a high speed, small footprint parser for extracting class/interface/method definitions from source files complete with JavaDoc @tags. It is designed to be used by active code generators or documentation tools.
There is a newer version: 2.1.0
Show newest version
package com.thoughtworks.qdox.model.impl;

import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.ListIterator;

import com.thoughtworks.qdox.model.DocletTag;
import com.thoughtworks.qdox.model.JavaClass;
import com.thoughtworks.qdox.model.JavaExecutable;
import com.thoughtworks.qdox.model.JavaMethod;
import com.thoughtworks.qdox.model.JavaParameter;
import com.thoughtworks.qdox.model.JavaType;

/**
 * The BaseMethod contains all methods used by both JavaMethod and JavaConstructor 
 * 
 * @author Robert Scholte
 *
 */
public abstract class DefaultJavaExecutable 
    extends AbstractInheritableJavaEntity implements JavaExecutable
{

    private List parameters = Collections.emptyList();
    private List exceptions = Collections.emptyList();
    private boolean varArgs;
    private String sourceCode;

    /** {@inheritDoc} */
    public List getParameters()
    {
        return parameters;
    }

    /** {@inheritDoc} */
    public JavaParameter getParameterByName( String name )
    {
        for (JavaParameter parameter : getParameters()) {
            if (parameter.getName().equals(name)) {
                return parameter;
            }
        }
        return null;
    }

    /** {@inheritDoc} */
    public List getExceptions()
    {
        return new LinkedList( exceptions );
    }

    /** {@inheritDoc} */
    public List getExceptionTypes()
    {
        return new LinkedList( exceptions );
    }

    /** {@inheritDoc} */
    public boolean isVarArgs()
    {
        return varArgs;
    }

    public void setParameters( List javaParameters )
    {
        parameters = javaParameters;
        this.varArgs = javaParameters.get( javaParameters.size() -1 ).isVarArgs();
    }

    public void setExceptions( List exceptions )
    {
        this.exceptions = exceptions;
    }

    protected boolean signatureMatches( List parameterTypes, boolean varArgs )
    {
        List parameterTypeList;
        if( parameterTypes == null) {
            parameterTypeList = Collections.emptyList();
        }
        else {
            parameterTypeList = parameterTypes;
        }
        
        if (parameterTypeList.size() != this.getParameters().size()) 
        {
            return false;   
        }
        
        for (int i = 0; i < getParameters().size(); i++) 
        {
            if (!getParameters().get(i).getType().equals(parameterTypes.get(i))) {
                return false;
            }
        }
        return (this.varArgs == varArgs);
    }

    /** {@inheritDoc} */
    @Override
	public boolean isPublic()
    {
        return super.isPublic() || (getDeclaringClass() != null ? getDeclaringClass().isInterface() : false);
    }

    /** {@inheritDoc} */
    @Override
	public List getTagsByName( String name, boolean inherited )
    {
        JavaClass cls = getDeclaringClass();
        List types = new LinkedList();
        for (JavaParameter parameter : getParameters()) {
            types.add(parameter.getType());
        }
        List methods = cls.getMethodsBySignature(getName(), types, true);
    
        List result = new LinkedList();
        for (JavaMethod method : methods) {
            List tags = method.getTagsByName(name);
            for (DocletTag tag : tags) {
                if(!result.contains(tag)) {
                    result.add(tag);
                }
            }
        }
        return result;
    }

    /** {@inheritDoc} */
    public List getParameterTypes()
    {
        return getParameterTypes( false );
    }

    /** {@inheritDoc} */
    public List getParameterTypes( boolean resolve )
    {
        List result = new LinkedList();
        for ( JavaParameter parameter : this.getParameters() )
        {
            result.add( parameter.getType() );
        }
        return result;
    }

    /** {@inheritDoc} */
    public String getSourceCode()
    {
    	return sourceCode;
    }

    public void setSourceCode( String sourceCode )
    {
    	this.sourceCode = sourceCode;
    }

    public String getCallSignature()
    {
        return getSignature( false,  false );
    }
    
    // only here for shared signature-code.
    protected JavaType getReturns()
    {
        return null;
    }

    /**
     * @since 1.3
     */
    protected String getSignature( boolean withModifiers, boolean isDeclaration )
    {
        StringBuilder result = new StringBuilder();
        if ( withModifiers )
        {
            for ( String modifier : getModifiers() )
            {
                // check for public, protected and private
                if ( modifier.startsWith( "p" ) )
                {
                    result.append( modifier ).append( ' ' );
                }
            }
            for ( String modifier : getModifiers() )
            {
                // check for public, protected and private
                if ( !modifier.startsWith( "p" ) )
                {
                    result.append( modifier ).append( ' ' );
                }
            }
        }
    
        if ( isDeclaration && getReturns() != null )
        {
            
            result.append( getReturns().getGenericCanonicalName() );
            result.append( ' ' );
        }
    
        result.append( getName() );
        result.append( '(' );
        for ( ListIterator iter = getParameters().listIterator(); iter.hasNext(); )
        {
            JavaParameter parameter = iter.next();
            if ( isDeclaration )
            {
                result.append( parameter.getType().getGenericCanonicalName() );
                if ( parameter.isVarArgs() )
                {
                    result.append( "..." );
                }
                result.append( ' ' );
            }
            result.append( parameter.getName() );
            if ( iter.hasNext() )
            {
                result.append( ", " );
            }
        }
        result.append( ')' );
        if ( isDeclaration && !getExceptions().isEmpty() )
        {
            result.append( " throws " );
            for ( Iterator excIter = getExceptions().iterator(); excIter.hasNext(); )
            {
                result.append( excIter.next().getGenericCanonicalName() );
                if ( excIter.hasNext() )
                {
                    result.append( ", " );
                }
            }
        }
        return result.toString();
    }

}