Class FileListParameter

  • All Implemented Interfaces:
    Parameter<java.util.List<java.net.URI>>

    public class FileListParameter
    extends ListParameter<FileListParameter,​java.util.List<java.net.URI>>
    Parameter class for a parameter specifying a list of files.
    Since:
    0.3
    Author:
    Steffi Wanka, Erich Schubert
    • Field Detail

      • filesType

        private FileListParameter.FilesType filesType
        Specifies the type of the files, i.e. if the files are input or output files.
    • Constructor Detail

      • FileListParameter

        public FileListParameter​(OptionID optionID,
                                 FileListParameter.FilesType filesType)
        Constructs a file list parameter with the given optionID, and file type.
        Parameters:
        optionID - the unique id of this file list parameter
        filesType - the file type of this file list parameter
    • Method Detail

      • getValueAsString

        public java.lang.String getValueAsString()
        Description copied from interface: Parameter
        Get the value as string. May return null
        Returns:
        Value as string
      • getSyntax

        public java.lang.String getSyntax()
        Returns a string representation of the parameter's type.
        Returns:
        "<file_1,...,file_n>"
      • grab

        public boolean grab​(Parameterization config,
                            java.util.function.Consumer<java.util.List<java.net.URI>> consumer)
        Get the parameter.
        Parameters:
        config - Parameterization
        consumer - Output consumer
        Returns:
        true if valid