uk.ac.bristol.star.cdf.util
Class CdfList

java.lang.Object
  extended by uk.ac.bristol.star.cdf.util.CdfList

public class CdfList
extends java.lang.Object

Utility to describe a CDF file, optionally with record data. Intended to be used from the commandline via the main method. The output format is somewhat reminiscent of the cdfdump command in the CDF distribution.

Since:
21 Jun 2013

Constructor Summary
CdfList(CdfContent cdf, java.io.PrintStream out, boolean writeData)
          Constructor.
 
Method Summary
static void main(java.lang.String[] args)
          Main method.
 void run()
          Does the work, writing output.
static int runMain(java.lang.String[] args)
          Does the work for the command line tool, handling arguments.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CdfList

public CdfList(CdfContent cdf,
               java.io.PrintStream out,
               boolean writeData)
Constructor.

Parameters:
cdf - CDF content
out - output stream for listing
writeData - true if data values as well as metadata are to be written
Method Detail

run

public void run()
         throws java.io.IOException
Does the work, writing output.

Throws:
java.io.IOException

runMain

public static int runMain(java.lang.String[] args)
                   throws java.io.IOException
Does the work for the command line tool, handling arguments. Sucess is indicated by the return value.

Parameters:
args - command-line arguments
Returns:
0 for success, non-zero for failure
Throws:
java.io.IOException

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException
Main method. Use -help for arguments.

Throws:
java.io.IOException