|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.enhydra.xml.xmlc.taskdef.XmlcUtils
Abstract base xmlc utilities class
Field Summary | |
static String |
DEFAULT_OPTIONS_FILENAME
The name of the default XMLC options file. |
static String |
DEFAULT_OPTIONS_FILETYPE
The default extension for an XMLC options file. |
static String |
DEFAULT_UTILS_CLASS_KEY
The system property holding the classname of the class to instantiate when XmlcUtils.create() is called. |
static String |
DEFAULT_UTILS_CLASS_NAME
The default classname of the class to instantiate when XmlcUtils.create() is called. |
Constructor Summary | |
protected |
XmlcUtils()
Construct default XmlcUtils (protected to force the use of XmlcUtils.create() factory method). |
Method Summary | |
abstract String |
buildClassName(String theFullBaseFileName,
String theModifier)
Build a Java class name out of the specified components. |
abstract String |
buildFullBaseFileName(String thePackageName,
String thePackageDir,
String theBaseFileName)
Build a full base file name (i.e. |
static XmlcUtils |
create()
Factory method for creating instances of the XmlcUtils class. |
abstract String[] |
getOptionFiles(File theDirectory)
Get a list of options files for the specified directory. |
abstract String[] |
getOptionFiles(File[] theDirectories,
String theOptionsFileName)
Get a list of options files for the specified directories, having the specified name. |
abstract String[] |
getOptionFiles(File[] theDirectories,
String[] theOptionsFileNames)
Get a list of options files for the specified directories, having the specified names. |
abstract String[] |
getOptionFiles(File theDirectory,
String theOptionsFileName)
Get a list of options files for the specified directory, having the specified name. |
abstract String[] |
getOptionFiles(File theDirectory,
String[] theOptionsFileNames)
Get a list of options files for the specified directory, having the specified names. |
Methods inherited from class java.lang.Object |
|
Field Detail |
public static final String DEFAULT_OPTIONS_FILETYPE
public static final String DEFAULT_OPTIONS_FILENAME
public static final String DEFAULT_UTILS_CLASS_KEY
public static final String DEFAULT_UTILS_CLASS_NAME
Constructor Detail |
protected XmlcUtils()
Method Detail |
public abstract String[] getOptionFiles(File theDirectory)
theDirectory
- The directory to look in for the options file.public abstract String[] getOptionFiles(File theDirectory, String theOptionsFileName)
theDirectory
- The directory to look in for the options file.theOptionsFileName
- The name of the options file to look for.public abstract String[] getOptionFiles(File theDirectory, String[] theOptionsFileNames)
theDirectory
- The directory to look in for the options file.theOptionsFileNames
- The list of names of the options file to look for.public abstract String[] getOptionFiles(File[] theDirectories, String theOptionsFileName)
theDirectories
- The list of directories to look in for the options files.theOptionsFileName
- The name of the options file to look for.public abstract String[] getOptionFiles(File[] theDirectories, String[] theOptionsFileNames)
theDirectories
- The list of directories to look in for the options files.theOptionsFileNames
- The list of names of the options file to look for.public abstract String buildFullBaseFileName(String thePackageName, String thePackageDir, String theBaseFileName)
thePackageName
- The name of the package to prepend to the file name.
This should be specified using the Java naming convention
i.e. org.enhydra.xmlcthePackageDir
- The name of the directory to prepend to the file name.
This is a directory path that can be specified using either '/' or '\'
i.e. foo/resourcestheBaseFileName
- The base file name that the preceding strings are prepended to.public abstract String buildClassName(String theFullBaseFileName, String theModifier)
theFullBaseFileName
- The full base file name (specified with '/' separators)
and no file type. e.g. "org.enhydra.test"theModifier
- The file modifier to append to the class name
e.g. HTMLpublic static XmlcUtils create()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |