public class EmptyLoadedData extends java.lang.Object implements LoadedData
LoadedData
interface, which
contains no data, only an optional single message.
The class is intended to provide a convenient "null object" which can be returned when file loading fails entirely, hopefully containing an explanation of why it failed entirely.
Constructor and Description |
---|
EmptyLoadedData()
Instantiate an
EmptyLoadedData object with no message. |
EmptyLoadedData(java.lang.String message)
Instantiate an
EmptyLoadedData object with a single message. |
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.String> |
getExtraLines()
Returns a list of non-processed raw lines from the file.
|
java.util.List<java.lang.String> |
getMessages()
Returns a list of messages produced during file reading, intended for
presentation to the user.
|
java.util.List<TreatmentStep> |
getTreatmentSteps()
Returns the treatment steps read from the file.
|
public EmptyLoadedData(java.lang.String message)
EmptyLoadedData
object with a single message.
The message will be returned in a list by getMessages()
.message
- the message with which to populate this objectpublic EmptyLoadedData()
EmptyLoadedData
object with no message.public java.util.List<TreatmentStep> getTreatmentSteps()
LoadedData
getTreatmentSteps
in interface LoadedData
public java.util.List<java.lang.String> getMessages()
LoadedData
getMessages
in interface LoadedData
public java.util.List<java.lang.String> getExtraLines()
LoadedData
Suite
.
Currently it is only used to allow PplLoader
to pass sample-,
site-, and suite-level data on to the suite, and is ignored by
Suite
for all other loader classes.getExtraLines
in interface LoadedData