Modifier and Type | Field and Description |
---|---|
static Plugin[] |
EMPTY_LIST
A ready-to-use empty array of plugins.
|
boolean |
multiFileOutput
true if this plugin creates multiple output files
(like Web Help);
false if this plugin creates a single output file
(like EPUB). |
String |
name
The unique name (a single word) of the plugin.
|
String |
outputDescription
A short description (just a few words) of the output files
created by this plugin.
|
String |
outputExtension
The suggested file extension, without a leading dot,
for the output files created by this plugin.
|
String[] |
w2xArguments
Some w2x command-line arguments specifying what does
this plugin.
|
Constructor and Description |
---|
Plugin(String name,
String outputDescription,
String outputExtension,
boolean multiFileOutput,
String[] w2xArguments)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static Plugin |
load(URL url)
Load the plugin found in specified location.
|
static Plugin[] |
loadAll(URL[] urls,
List<String> errorList)
Load all the plugins found in specified locations.
|
String |
toString()
Returns a parsable representation of this plugin, that is,
the content of a .w2x_plugin file.
|
public final String name
public final String outputDescription
null
.public final String outputExtension
public final boolean multiFileOutput
true
if this plugin creates multiple output files
(like Web Help);
false
if this plugin creates a single output file
(like EPUB).public final String[] w2xArguments
public static final Plugin[] EMPTY_LIST
public String toString()
public static Plugin[] loadAll(URL[] urls, List<String> errorList)
urls
- locations of .w2x_plugin files.errorList
- error messages reported while loading the plugins
are added to this list.load(java.net.URL)
public static Plugin load(URL url) throws IOException, UsageException
url
- location of a .w2x_plugin file.IOException
- problem reading the file or missing plugin fieldsUsageException
- syntax errors in loaded
w2x command-line argumentsloadAll(java.net.URL[], java.util.List<java.lang.String>)