net.sf.jameleon.bean
Class Javadoc2Bean

java.lang.Object
  net.sf.jameleon.bean.Javadoc2Bean

public class Javadoc2Bean
extends Object

Field Summary

protected JavaDocBuilder	docBuilder
protected String	isA
protected Map	serializedFiles
protected File	sourceDir

Constructor Summary

Javadoc2Bean()
Default constructor only used to initialize variables

Method Summary

protected void	addApplications(FunctionalPoint fp, JavaClass clss)
protected void	addClassDocs(FunctionalPoint fp, JavaClass clss)
protected void	addDocsFromSerializedFP(FunctionalPoint fp, JavaClass clss)
protected void	addFields(FunctionalPoint fp, JavaClass clss)
protected void	addFieldsFromSuperclassAndInterfaces(Set signatures, List fieldList, JavaClass clazz)
protected void	addMethods(FunctionalPoint fp, JavaClass clss)
protected void	addSteps(FunctionalPoint fp, JavaClass clss)
String	convertClassNameToSourceName(String className, boolean appendJava)
protected String	convertNullToString(String str)
protected Attribute	createAttributeFromTag(AbstractJavaEntity aje, String name, String type, String contextName, boolean instanceVariable)
String	getClassNameFromSource(String sourceFileName)
protected JavaField[]	getFields(JavaClass clss)
protected String	getFirstParameterTypeFromJavaMethod(JavaMethod method) XJavadoc only gets the unqualified type of the instance variable, e.g.
FunctionalPoint	getFunctionalPoint(JavaClass clss)
protected FunctionalPoint	getFunctionalPointFromSerializedFile(JavaClass clss)
FunctionalPoint	getFunctionalPointWithClass(String className)
FunctionalPoint	getFunctionalPointWithSource(File sourceFile)
String	getIsA()
protected JavaClass	getJavaClassWithClass(String className)
protected JavaClass	getJavaClassWithSource(File sourceFile)
JavaDocBuilder	getJavaDocBuilder()
protected String	getShortDescription(String description)
File	getSourceDir()
File	getSourceFile(String className)
void	setIsA(String isA)
void	setSourceDir(File sourceDir)
protected JavaDocBuilder	setUpSourceSet()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sourceDir

protected File sourceDir

isA

protected String isA

docBuilder

protected JavaDocBuilder docBuilder

serializedFiles

protected Map serializedFiles

Constructor Detail

Javadoc2Bean

public Javadoc2Bean()

Default constructor only used to initialize variables

Method Detail

getClassNameFromSource

public String getClassNameFromSource(String sourceFileName)
                              throws MissingResourceException

Throws:

MissingResourceException

getSourceFile

public File getSourceFile(String className)

convertClassNameToSourceName

public String convertClassNameToSourceName(String className,
                                           boolean appendJava)

getSourceDir

public File getSourceDir()

setSourceDir

public void setSourceDir(File sourceDir)

getIsA

public String getIsA()

setIsA

public void setIsA(String isA)

getFunctionalPointWithClass

public FunctionalPoint getFunctionalPointWithClass(String className)
                                            throws FileNotFoundException

Throws:

FileNotFoundException

getFunctionalPointWithSource

public FunctionalPoint getFunctionalPointWithSource(File sourceFile)
                                             throws FileNotFoundException

Throws:

FileNotFoundException

getFunctionalPoint

public FunctionalPoint getFunctionalPoint(JavaClass clss)

getFunctionalPointFromSerializedFile

protected FunctionalPoint getFunctionalPointFromSerializedFile(JavaClass clss)

addDocsFromSerializedFP

protected void addDocsFromSerializedFP(FunctionalPoint fp,
                                       JavaClass clss)

addClassDocs

protected void addClassDocs(FunctionalPoint fp,
                            JavaClass clss)

getShortDescription

protected String getShortDescription(String description)

addApplications

protected void addApplications(FunctionalPoint fp,
                               JavaClass clss)

addSteps

protected void addSteps(FunctionalPoint fp,
                        JavaClass clss)

addMethods

protected void addMethods(FunctionalPoint fp,
                          JavaClass clss)

addFields

protected void addFields(FunctionalPoint fp,
                         JavaClass clss)

getFields

protected JavaField[] getFields(JavaClass clss)

addFieldsFromSuperclassAndInterfaces

protected void addFieldsFromSuperclassAndInterfaces(Set signatures,
                                                    List fieldList,
                                                    JavaClass clazz)

createAttributeFromTag

protected Attribute createAttributeFromTag(AbstractJavaEntity aje,
                                           String name,
                                           String type,
                                           String contextName,
                                           boolean instanceVariable)

getJavaDocBuilder

public JavaDocBuilder getJavaDocBuilder()

setUpSourceSet

protected JavaDocBuilder setUpSourceSet()

getJavaClassWithClass

protected JavaClass getJavaClassWithClass(String className)
                                   throws FileNotFoundException

Throws:

FileNotFoundException

getJavaClassWithSource

protected JavaClass getJavaClassWithSource(File sourceFile)
                                    throws FileNotFoundException

Throws:

FileNotFoundException

convertNullToString

protected String convertNullToString(String str)

getFirstParameterTypeFromJavaMethod

protected String getFirstParameterTypeFromJavaMethod(JavaMethod method)

XJavadoc only gets the unqualified type of the instance variable, e.g. String not java.lang.String But on method params, XJavadoc gets the fully qualified name Since we use both, we want to make it consistent

Parameters:

method - - the method that represents the attribute

Returns:

the first parameter type as a String, fully qualified.