FileLoader

All Known Implementing Classes:

CaltechLoader, IapdLoader, Jr6Loader, PmdLoader, PplLoader, TabularFileLoader, TwoGeeLoader, UcDavisLoader, ZplotLoader
```
public interface FileLoader
```
An interface implemented by PuffinPlot file loaders. It provides methods for producing a LoadedData object from a file.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`checkOptions(java.util.Map<java.lang.String,java.lang.Object> options)` Check that a set of options is valid for this file loader.
`default java.util.List<OptionDefinition>`	`getOptionDefinitions()`
`default LoadedData`	`readFile(java.io.File file)` Reads a file without any specified options.
`LoadedData`	`readFile(java.io.File file, java.util.Map<java.lang.String,java.lang.Object> options)` Read a file using a specified set of options.

- Method Detail
  - readFile
```
LoadedData readFile(java.io.File file,
                    java.util.Map<java.lang.String,java.lang.Object> options)
```
    Read a file using a specified set of options. The supported options should correspond to the option definitions returned by getOptionDefinitions().
    
    Parameters:
    
    file - the file to read
    
    options - file reading options
    
    Returns:
    
    a representation of the data within the specified file
  - readFile
```
default LoadedData readFile(java.io.File file)
```
    Reads a file without any specified options. The implementer is expected to use default options.
    
    Parameters:
    
    file - the file to read
    
    Returns:
    
    a representation of the data within the specified file
  - getOptionDefinitions
```
default java.util.List<OptionDefinition> getOptionDefinitions()
```
    Returns:
    
    a list defining the options supported by this loader
  - checkOptions
```
default void checkOptions(java.util.Map<java.lang.String,java.lang.Object> options)
```
    Check that a set of options is valid for this file loader. The options map must be non-null. All required options must be present. No unknown options may be present. Every value must be of the correct class. If any of these checks fail, an IllegalArgumentException is thrown. Additionally, the default values of the options are checked. If any of them is of the wrong class, an IllegalStateException is thrown.
    
    Parameters:
    
    options - the options to check

Interface FileLoader

Method Summary

Method Detail

readFile

readFile

getOptionDefinitions

checkOptions