Package org.biojava.nbio.structure.io.cif

Interface CifFileConsumer<S>

Type Parameters:
S - the type of container an implementing class will return
All Known Subinterfaces:
ChemCompConsumer, CifStructureConsumer, MetalBondConsumer
All Known Implementing Classes:
ChemCompConsumerImpl, CifStructureConsumerImpl, MetalBondConsumerImpl
public interface CifFileConsumer<S>
Defines a rather generic interface which allows to populate some data structure with data parsed from a CIF file.
Since:
5.3.0
Author:
Sebastian Bittrich

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    finish()
    Ultimate setup which can include steps which require several categories to be available and integrate them into the final container.
    S
    getContainer()
    Retrieve the created container representing a CIF file.
    void
    prepare()
    Setup routine which initializes a new container.

  • Method Details

    • prepare

      void prepare()
      Setup routine which initializes a new container.

    • finish

      void finish()
      Ultimate setup which can include steps which require several categories to be available and integrate them into the final container.

    • getContainer

      S getContainer()
      Retrieve the created container representing a CIF file.
      Returns:
      all desired information wrapped as object of type S