org.apache.felix.scrplugin.tags
Interface JavaClassDescription

All Known Implementing Classes:
ClassLoaderJavaClassDescription, QDoxJavaClassDescription

public interface JavaClassDescription

JavaClassDescription.java... Description of a java class


Field Summary
static JavaClassDescription[] EMPTY_RESULT
           
 
Method Summary
 JavaField getExternalFieldByName(java.lang.String name)
           
 JavaField getFieldByName(java.lang.String name)
          Get the field with the name.
 JavaField[] getFields()
          Get the fields of this class
 JavaClassDescription[] getImplementedInterfaces()
          Returns an array of the implemented interfaces of this class.
 JavaMethod getMethodBySignature(java.lang.String name, java.lang.String[] parameters)
          Search for a method with the given signature.
 JavaMethod[] getMethods()
          Return all methods of this class
 java.lang.String getName()
          Get the name of the described class.
 JavaClassDescription getReferencedClass(java.lang.String referencedName)
          Search for the class.
 JavaClassDescription getSuperClass()
          Get the description for the parent class.
 JavaTag getTagByName(java.lang.String name)
          Get the java class tag with the name.
 JavaTag[] getTagsByName(java.lang.String name, boolean inherited)
          Get all class tags with this name.
 boolean isA(java.lang.String type)
          Is this class of the type?
 boolean isAbstract()
          Is this class abstract?
 boolean isInterface()
          Is this class an interface?
 boolean isPublic()
          Is this class public?
 

Field Detail

EMPTY_RESULT

static final JavaClassDescription[] EMPTY_RESULT
Method Detail

getTagByName

JavaTag getTagByName(java.lang.String name)
Get the java class tag with the name.

Parameters:
name -
Returns:
the tag or null.

getTagsByName

JavaTag[] getTagsByName(java.lang.String name,
                        boolean inherited)
                        throws org.apache.maven.plugin.MojoExecutionException
Get all class tags with this name.

Parameters:
name -
inherited - If true, parent classes are searched as well.
Returns:
An array of tags or the empty array.
Throws:
org.apache.maven.plugin.MojoExecutionException

getSuperClass

JavaClassDescription getSuperClass()
                                   throws org.apache.maven.plugin.MojoExecutionException
Get the description for the parent class.

Returns:
The description or null if this class is the Object class.
Throws:
org.apache.maven.plugin.MojoExecutionException

getName

java.lang.String getName()
Get the name of the described class.

Returns:
The name of the described class.

getFields

JavaField[] getFields()
Get the fields of this class

Returns:
All fields or an empty array

getFieldByName

JavaField getFieldByName(java.lang.String name)
                         throws org.apache.maven.plugin.MojoExecutionException
Get the field with the name.

Parameters:
name - The name of the field
Returns:
The field with the name or null.
Throws:
org.apache.maven.plugin.MojoExecutionException

getExternalFieldByName

JavaField getExternalFieldByName(java.lang.String name)
                                 throws org.apache.maven.plugin.MojoExecutionException
Throws:
org.apache.maven.plugin.MojoExecutionException

getImplementedInterfaces

JavaClassDescription[] getImplementedInterfaces()
                                                throws org.apache.maven.plugin.MojoExecutionException
Returns an array of the implemented interfaces of this class.

Returns:
An array containing the interfaces or an empty array if this class does not implement any interface.
Throws:
org.apache.maven.plugin.MojoExecutionException

getMethodBySignature

JavaMethod getMethodBySignature(java.lang.String name,
                                java.lang.String[] parameters)
                                throws org.apache.maven.plugin.MojoExecutionException
Search for a method with the given signature.

Parameters:
name -
parameters -
Returns:
A descriptor for the method or null
Throws:
org.apache.maven.plugin.MojoExecutionException

isPublic

boolean isPublic()
Is this class public?

Returns:
True if this class is public.

isAbstract

boolean isAbstract()
Is this class abstract?

Returns:
True if this class is abstract.

isInterface

boolean isInterface()
Is this class an interface?

Returns:
True if this is an interface.

getMethods

JavaMethod[] getMethods()
Return all methods of this class

Returns:
An array of methods or an empty array.

isA

boolean isA(java.lang.String type)
            throws org.apache.maven.plugin.MojoExecutionException
Is this class of the type?

Parameters:
type -
Returns:
True if this class is of the type.
Throws:
org.apache.maven.plugin.MojoExecutionException

getReferencedClass

JavaClassDescription getReferencedClass(java.lang.String referencedName)
                                        throws org.apache.maven.plugin.MojoExecutionException
Search for the class. If the referenced name is not fully qualified, the imports of the class are searched.

Parameters:
referencedName -
Returns:
The java class description or null
Throws:
org.apache.maven.plugin.MojoExecutionException


Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.