jimmc.roots
Class PrintFormat

java.lang.Object
  |
  +--jimmc.roots.PrintFormat
All Implemented Interfaces:
PrintHelp

public abstract class PrintFormat
extends java.lang.Object
implements PrintHelp


Field Summary
protected  CommandInterpreter ci
           
 
Constructor Summary
PrintFormat(CommandInterpreter ci)
          Set up common stuff for subclasses.
 
Method Summary
static void AddDefaultFormats(CommandInterpreter ci)
          Add the default print formats
 RecordFormat getDefaultRecordFormat()
          Get the default record format for this print format.
abstract  java.lang.String getName()
          Get the name of this format.
 void printOneLineHelp()
          Print out short help
abstract  void printRecords(PrintOptions po, RootsRecord[] ra)
          Print the specified records in this format.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ci

protected CommandInterpreter ci
Constructor Detail

PrintFormat

public PrintFormat(CommandInterpreter ci)
Set up common stuff for subclasses.
Method Detail

getName

public abstract java.lang.String getName()
Get the name of this format.
Returns:
the name of this format.

getDefaultRecordFormat

public RecordFormat getDefaultRecordFormat()
Get the default record format for this print format.
Returns:
default format, or null if no default

printRecords

public abstract void printRecords(PrintOptions po,
                                  RootsRecord[] ra)
Print the specified records in this format.
Parameters:
po - the print control options
ra - the records to print

printOneLineHelp

public void printOneLineHelp()
Print out short help
Specified by:
printOneLineHelp in interface PrintHelp

AddDefaultFormats

public static void AddDefaultFormats(CommandInterpreter ci)
Add the default print formats