Package bref

Class Bref3Reader


  • public final class Bref3Reader
    extends java.lang.Object

    Class Bref3Reader contains methods for reading a bref 3 (binary reference format) file.

    Instances of class Bref3Reader are not thread-safe.

    Methods of this class will terminate the Java Virtual Machine with an error message if an I/O error or file format error is detected.

    • Constructor Summary

      Constructors 
      Constructor Description
      Bref3Reader​(java.io.DataInput bref, Filter<Marker> markerFilter)
      Constructs a new Bref3Reader instance.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Bref3Reader

        public Bref3Reader​(java.io.DataInput bref,
                           Filter<Marker> markerFilter)
        Constructs a new Bref3Reader instance.
        Parameters:
        bref - a DataInput instance reading from a bref v3 file
        markerFilter - a marker filter or null
        Throws:
        java.lang.IllegalArgumentException - if a format error is detected in a line of the specified bref v3 file
        java.lang.NullPointerException - if file == null
    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object