uk.ac.starlink.gbin
Class GbinMetadataReader

java.lang.Object
  uk.ac.starlink.gbin.GbinMetadataReader

public class GbinMetadataReader
extends Object

Provides a utility method for reading metadata from a GBIN file.

Since:

13 Aug 2014

Constructor Summary

GbinMetadataReader()

Method Summary

static GbinMeta	attemptReadMetadata(Object gbinReaderObj) Attempts to read a metadata object from a GbinReader object.
static void	main(String[] args) Attempts to read metadata from the GBIN file named on the command line and writes the description to stdout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GbinMetadataReader

public GbinMetadataReader()

Method Detail

attemptReadMetadata

public static GbinMeta attemptReadMetadata(Object gbinReaderObj)
                                    throws Throwable

Attempts to read a metadata object from a GbinReader object.

NOTE: this method is effectively destructive: if you read metadata from a GbinReader you cannot then go on to read data records from it.

A wide range of exceptions and errors may be thrown by this method, since it involves reflection all sorts of things can go wrong.

Parameters:

gbinReaderObj - object implementing gaia.cu1.tools.dal.gbin.GbinReader

Returns:

metadata if possible

Throws:

Throwable

main

public static void main(String[] args)
                 throws Throwable

Attempts to read metadata from the GBIN file named on the command line and writes the description to stdout.

Throws:

Throwable