public abstract class BasicFilter extends java.lang.Object implements ProcessingFilter
Modifier | Constructor and Description |
---|---|
protected |
BasicFilter(java.lang.String name,
java.lang.String usage)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
explainSyntax(java.lang.String[] usages)
Returns a snippet of XML explaining use of the syntax of some given
usage-type example arguments.
|
java.lang.String |
getDescription()
Description for this filter.
|
protected abstract java.lang.String[] |
getDescriptionLines() |
java.lang.String |
getName() |
java.lang.String |
getUsage()
Usage message for this filter.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createStep
protected BasicFilter(java.lang.String name, java.lang.String usage)
name
- filter nameusage
- filter usagepublic java.lang.String getName()
public java.lang.String getUsage()
ProcessingFilter
getUsage
in interface ProcessingFilter
public java.lang.String getDescription()
ProcessingFilter
getDescription
in interface ProcessingFilter
protected abstract java.lang.String[] getDescriptionLines()
public static java.lang.String explainSyntax(java.lang.String[] usages)
usages
- array of formal arguments to be explainedCopyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.