Class InputArguments

Object
InputArguments

public class InputArguments extends Object
Arguments that can further specify an experiment's input in addition to its bean specification.
Author:
Owen Feehan
  • Constructor Details

    • InputArguments

      public InputArguments()
  • Method Details

    • getModelDirectory

      public Path getModelDirectory()
      A directory indicating where models can be located.
      Returns:
      the path to the directory.
    • assignModelDirectory

      public void assignModelDirectory(Path modelDirectory)
      Assigns a directory indicating where models can be located.
      Parameters:
      modelDirectory - the directory.
    • assignCopyNonInputs

      public void assignCopyNonInputs()
      Activates a toggle where any files in the input directory that are unused as inputs, are copied to the output directory.
    • assignCallUponDirectoryCreation

      public void assignCallUponDirectoryCreation(Consumer<Path> consumer)
      Indicates that consumer will be called when an output directory is first created.

      This occurs as directories are created lazily only when first needed.

      It is called with the path of the directory as an argument.

      Parameters:
      consumer - the consumer that is called.
    • getContextParameters

      public InputContextParameters getContextParameters()
      Context parameters that an influence determining inputs.
    • isCopyNonInputs

      public boolean isCopyNonInputs()
      When true, any files in the input directory that are unused as inputs, are copied to the output directory.
    • getCallUponDirectoryCreation

      public Optional<Consumer<Path>> getCallUponDirectoryCreation()
      When defined, this Consumer is called when an output directory is first created.

      This occurs as directories are created lazily only when first needed.

      It is called with the path of the directory as an argument.