Package org.anchoranalysis.io.output.outputter

Class Outputter

Object
Outputter
public class Outputter extends Object
Like OutputterChecked but exceptions are reported in a ErrorReporter.
Author:
Owen Feehan

  • Constructor Details

  • Method Details

    • deriveSubdirectory

      public Outputter deriveSubdirectory(String subdirectoryName, boolean inheritOutputRulesAndRecording)
      Creates a new Outputter by appending a relative folder-path to the current Outputter
      Parameters:
      subdirectoryName - the subdirectory-name.
      inheritOutputRulesAndRecording - if true, the output rules and recording are inherited from the parent directory. if false, they are not, and all outputs are allowed and are unrecorded.
      Returns:
      the new output manager.
      See Also:

    • writerPermissive

      public WriterRouterErrors writerPermissive()
      The writer that allows all outputs.
      Returns:
      the permissive writer

    • writerSelective

      public WriterRouterErrors writerSelective()
      The writer that allows only certain selected outputs.
      Returns:
      the non-permissive writer

    • writerMultiplex

      public WriterRouterErrors writerMultiplex(boolean selectSelective)
      Multiplexes between the selective and permissive writers based on a flag.
      Parameters:
      selectSelective - if true, writerSelective() is returned, otherwise writerPermissive().
      Returns:
      the chosen writer

    • writerSecondLevel

      public WriterRouterErrors writerSecondLevel(String outputNameFirstLevel)
      A writer that performs a second-level check on which outputs occur, but writes to the top-level directory.
      Parameters:
      outputNameFirstLevel - the first-level outputName with which second-level checks are performed.
      Returns:
      a newly created writer checking on particular second-level output names.

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getSettings

      public OutputWriteSettings getSettings()
      General settings for outputting.
      Returns:
      the settings.

    • getOutputDirectory

      public Path getOutputDirectory()
      The directory into which outputting occurs.
      Returns:
      a path to the directory.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • outputsEnabled

      public MultiLevelOutputEnabled outputsEnabled()
      Which outputs are enabled or not enabled.
      Returns:
      an object indicating which outputs are enabled.

    • getChecked

      public OutputterChecked getChecked()
      Gets the underlying delegate of Outputter that throws checked-exceptions instead of using a ErrorReporter.
      Returns:
      the checked-ouputter.

    • getPrefix

      public DirectoryWithPrefix getPrefix()
      The directory and prefix into which outputting occurs.
      Returns:
      the directory and prefix.

    • getErrorReporter

      public ErrorReporter getErrorReporter()