|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--xjavadoc.XJavaDoc
This class represents the entry-point for xjavadoc classes. Come here to get classes and packages.
Nested Class Summary | |
static class |
XJavaDoc.NoInnerClassesPredicate
|
Field Summary | |
static String |
IS_UNICODE
Indicates whether this XJavaDoc was built with or without unicode support |
static int |
NO_IMPORTED_PACKAGES
messgage level for reporting unqualified classes when there are no imported packages |
static int |
ONE_OR_MORE_IMPORTED_PACKAGES
messgage level for reporting unqualified classes when there are one or more imported packages |
Constructor Summary | |
XJavaDoc()
|
Method Summary | |
void |
addAbstractFile(String qualifiedName,
AbstractFile file)
|
void |
addSourceSet(SourceSet sourceSet)
Adds a new set of java sources to be parsed. |
String |
dereferenceProperties(String value)
|
Map |
getPropertyMap()
|
Collection |
getSourceClasses()
Returns all classes in the registered source sets, including inner classes |
Collection |
getSourceClasses(boolean useNodeParser)
Deprecated. Call setUseNodeParser() prior to parsing and call the no-arg getSourceClasses() |
Collection |
getSourceClasses(boolean useNodeParser,
boolean inner)
Deprecated. Call setUseNodeParser() prior to parsing and call the no-arg getSourceClasses() or getSourceClasses(Predicate) with a Predicate that doesn't accept inner classes. |
Collection |
getSourceClasses(Predicate predicate)
|
XPackage |
getSourcePackage(String packageName)
Returns the package. |
Collection |
getSourcePackages()
Returns the packages of the specified classes during parsing. |
XClass |
getXClass(String qualifiedName)
Get the XClass corresponding to the qualifiedName. |
static void |
parsePropertyString(String value,
List fragments,
List propertyRefs)
Parses a string containing ${xxx} style property references
into two lists. |
void |
printLogMessages(PrintStream out,
int level)
Prints the log messages encountered during parsing |
static void |
printMemoryStatus()
Dump to sytem out the status of XJavadoc. |
static String |
replaceProperties(String value,
Map keys)
Replaces ${xxx} style constructions in the given value with the
string value of the corresponding data types. |
void |
reset()
Deprecated. use reset(boolean). |
void |
reset(boolean resetTimeStamp)
Resets the caches. |
void |
setPropertyMap(Map properties)
|
void |
setUseNodeParser(boolean useNodeParser)
This method can be called prior to parsing so that all classes are parsed with AST (to make it possible to write the source back to disk) |
XClass |
updateClassTag(String className,
String tagName,
String parameterName,
String parameterValue,
int tagIndex)
Describe what the method does |
XClass |
updateMethodTag(String className,
String methodNameWithSignature,
String tagName,
String parameterName,
String parameterValue,
int tagIndex)
Describe what the method does |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String IS_UNICODE
public static final int NO_IMPORTED_PACKAGES
public static final int ONE_OR_MORE_IMPORTED_PACKAGES
Constructor Detail |
public XJavaDoc()
Method Detail |
public static void printMemoryStatus()
public static String replaceProperties(String value, Map keys)
${xxx}
style constructions in the given value with the
string value of the corresponding data types. NOTE: This method was taken
directly from Ant's source code (org.apache.tools.ant.ProjectHelper) and
modified slightly to use a Map instead of a HashMap.
value
- The string to be scanned for property references. May be
null
, in which case this method returns immediately with
no effect.keys
- Mapping (String to String) of property names to their values.
Must not be null
.
null
if the original string is null
.public static void parsePropertyString(String value, List fragments, List propertyRefs)
${xxx}
style property references
into two lists. The first list is a collection of text fragments, while the
other is a set of string property names. null
entries in the
first list indicate a property reference from the second list. NOTE: This
method was taken directly from Ant's source code
(org.apache.tools.ant.ProjectHelper) with the BuildException throwing
removed.
value
- Text to parse. Must not be null
.fragments
- List to add text fragments to. Must not be null
.propertyRefs
- List to add property names to. Must not be null
public Collection getSourceClasses(Predicate predicate)
public Collection getSourceClasses(boolean useNodeParser, boolean inner)
useNodeParser
- inner
-
public Collection getSourceClasses(boolean useNodeParser)
useNodeParser
-
public Collection getSourceClasses()
public Collection getSourcePackages()
public Map getPropertyMap()
public XClass getXClass(String qualifiedName)
qualifiedName
- Fully qualified class name
public XPackage getSourcePackage(String packageName)
packageName
-
public void setUseNodeParser(boolean useNodeParser)
useNodeParser
- public void setPropertyMap(Map properties)
public void reset()
reset(true)
.
public void reset(boolean resetTimeStamp)
resetTimeStamp
- true if timestamps should be reset too.public void printLogMessages(PrintStream out, int level)
out
- level
- public void addSourceSet(SourceSet sourceSet)
sourceSet
- a set of java sources.public void addAbstractFile(String qualifiedName, AbstractFile file)
public XClass updateMethodTag(String className, String methodNameWithSignature, String tagName, String parameterName, String parameterValue, int tagIndex) throws XJavaDocException
className
- qualified name of classtagName
- tag nameparameterName
- parameter nameparameterValue
- new parameter valuetagIndex
- index of tag (??)methodNameWithSignature
- method name followed by signature. no
spaces. Ex:doIt(java.lang.String,int)
XJavaDocException
- If the tag for some reason couldn't be
updatedpublic XClass updateClassTag(String className, String tagName, String parameterName, String parameterValue, int tagIndex) throws XJavaDocException
className
- Describe what the parameter doestagName
- Describe what the parameter doesparameterName
- Describe what the parameter doesparameterValue
- Describe what the parameter doestagIndex
- Describe what the parameter does
XJavaDocException
- Describe the exceptionpublic String dereferenceProperties(String value)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |