uk.ac.starlink.ttools
Class EveryFilter
java.lang.Object
|
+--uk.ac.starlink.ttools.EveryFilter
- All Implemented Interfaces:
- ProcessingFilter
- public class EveryFilter
- extends Object
- implements ProcessingFilter
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
EveryFilter
public EveryFilter()
getName
public String getName()
- Description copied from interface:
ProcessingFilter
- Returns the name of this filter. Will be turned into a command-line
flag (by prepending a '-') so it should be short.
- Specified by:
getName
in interface ProcessingFilter
- Returns:
- short name
getFilterUsage
public String getFilterUsage()
- Description copied from interface:
ProcessingFilter
- Returns a usage string for this filter.
Describes in standard format any required or optional command-line
arguments required for it to work; this should match the
arguments that are judged as legal by
ProcessingFilter.createStep(java.util.Iterator)
.
- Specified by:
getFilterUsage
in interface ProcessingFilter
- Returns:
- usage string
createStep
public ProcessingStep createStep(Iterator argIt)
- Description copied from interface:
ProcessingFilter
- Creates a new ProcessingStep based on a sequence of command-line
arguments. The argIt argument is an iterator over the
command-line arguments positioned just before any arguments
intended for this filter. If legal, any that can be comprehended
by this filter should be read (iterated over) and removed,
and a ProcessingStep should accordingly be returned.
If they are illegal, null should be returned.
In the case of a successful (non-null) return, it is essential
that no arguments other than the ones intended for this
filter are read from the iterator.
- Specified by:
createStep
in interface ProcessingFilter
- Parameters:
argIt
- iterator over command-line arguments positioned
just after the -getName() flag