jimmc.roots
Class RecordFormat
java.lang.Object
|
+--jimmc.roots.RecordFormat
- All Implemented Interfaces:
- PrintHelp
- public abstract class RecordFormat
- extends java.lang.Object
- implements PrintHelp
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ci
protected CommandInterpreter ci
RecordFormat
public RecordFormat(CommandInterpreter ci)
- Set up common stuff for subclasses.
getName
public abstract java.lang.String getName()
- Get the name of this format.
- Returns:
- the name of this format.
formatRecord
public abstract java.lang.String formatRecord(PrintOptions po,
RootsRecord r)
- Format the specified record in this format.
- Parameters:
po
- the print options to control the formatr
- the record to format- Returns:
- the formatted data
printOneLineHelp
public void printOneLineHelp()
- Print out a one-line help
- Specified by:
printOneLineHelp
in interface PrintHelp
AddDefaultFormats
public static void AddDefaultFormats(CommandInterpreter ci)