|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.filter.BasicFilter
public abstract class BasicFilter
Basic implementation of ProcessingFilter methods. Utility superclass for implementing concrete ProcessingFilter.
Constructor Summary | |
---|---|
protected |
BasicFilter(String name,
String usage)
Constructor. |
Method Summary | |
---|---|
static String |
explainSyntax(String[] usages)
Returns a snippet of XML explaining use of the syntax of some given usage-type example arguments. |
String |
getDescription()
Description for this filter. |
protected abstract String[] |
getDescriptionLines()
|
String |
getName()
|
String |
getUsage()
Usage message for this filter. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface uk.ac.starlink.ttools.filter.ProcessingFilter |
---|
createStep |
Constructor Detail |
---|
protected BasicFilter(String name, String usage)
name
- filter nameusage
- filter usageMethod Detail |
---|
public String getName()
public String getUsage()
ProcessingFilter
getUsage
in interface ProcessingFilter
public String getDescription()
ProcessingFilter
getDescription
in interface ProcessingFilter
protected abstract String[] getDescriptionLines()
public static String explainSyntax(String[] usages)
usages
- array of formal arguments to be explained
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |