xdoclet.tagshandler
public class PackageTagsHandler extends AbstractProgramElementTagsHandler
Version: $Revision: 1.16 $
UNKNOWN: Oct 14, 2001 namespace = "Package"
Nested Class Summary | |
---|---|
static class | PackageTagsHandler.PackageSubstitution
It's good practice to put interfaces (such as remote/local interfaces, data objects and home interfaces) in a
separate "interfaces" package rather than in the EJB bean implementation package. |
Method Summary | |
---|---|
void | forAllPackages(String template, Properties attributes)
Iterates over all packages loaded by XJavadoc. |
static String | getPackageNameFor(XPackage pak, boolean withSubstitution)
Gets the name of a package, optionally applying any substitutions.
|
static String | getPackageNameFor(String packageName)
Gets a package name with any subsitutions applied.
|
static String | getPackageNameFor(String packageName, boolean withSubstitution)
Apply package substitutions. |
static ArrayList | getPackageSubstitutions(String subtaskName)
Gets any PackageSubstitutions defined for a specified subtask.
|
void | packageDeclarationOf(String template)
Writes the package declaration for the package name of the full-qualified class name specified in the body of
this tag. |
String | packageName()
Returns the current package name. |
String | packageNameAsPath()
Returns the current package name as a path.
|
static String | packageNameAsPathFor(XPackage pak)
Returns a package name as a path, after applying any substitutions.
|
static String | packageNameAsPathFor(String qualifiedName)
Returns a package name as a path, after applying any substitutions.
|
static String | packageNameAsPathWithoutSubstitutionFor(XPackage pak)
Returns a package name as a path, without applying any substitutions.
|
void | packageOf(String template)
Returns the not-full-qualified package name of the full-qualified class name specified in the body of this tag.
|
static String | replaceInline(String original, String oldOne, String newOne)
Replace the first occurrence of oldOne in original with newOne , or returns
the original string if oldOne is not found.
|
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block" name = "abstract" optional = "true" values = "true,false" description = "If true then accept * abstract classes also; otherwise don't." name = "type" optional = "true" description = "For all classes by the type." name = "extent" optional = "true" values = "concrete-type,superclass,hierarchy" description = "Specifies the extent of the type search. If concrete-type then only check the concrete type, if * superclass then check also superclass, if hierarchy then search the whole hierarchy and find if the class is * of the specified type. Default is hierarchy."
Parameters: pak package withSubstitution whether to apply any substitutions
Returns: package name
Parameters: packageName package name
Returns: package name
Parameters: packageName The (current) package name, on which substitution shall take place. withSubstitution true if package substitutions shall take place.
Returns: The package name after substitutions.
Parameters: subtaskName subtask name
Returns: ArrayList of substitutions
Parameters: template The body of the block tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block"
Returns: current package name
Throws: XDocletException Description of Exception
UNKNOWN: type = "content"
Returns: current package name as path
Throws: XDocletException Description of Exception
UNKNOWN: type = "content"
Parameters: pak package
Returns: package name as path
UNKNOWN: type = "content"
Parameters: qualifiedName package name
Returns: package name as path
UNKNOWN: type = "content"
Parameters: pak package
Returns: package name as path
UNKNOWN: type = "content"
Parameters: template The body of the block tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block"
oldOne
in original
with newOne
, or returns
the original string if oldOne
is not found.
Parameters: original String in which replacement should occour oldOne String to be replaced newOne String that replaces
Returns: String original string with replacements