|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectsbrt.shell.io.AbstractMapOutputFile<K,V>
K
- the key type.V
- the value type.public abstract class AbstractMapOutputFile<K,V>
This abstract class is a skeleton implementation of MapTextOutputFile.
Constructor Summary | |
---|---|
AbstractMapOutputFile(java.lang.String fileName,
FileFormat fileFormat,
MapFormat<K,V> mapFormat)
Constructs a new vector output file from the provided arguments. |
|
AbstractMapOutputFile(java.lang.String fileName,
FileFormat fileFormat,
java.util.Set<? extends K> keys,
MapFormat<K,V> mapFormat)
Constructs a new map output file from the provided arguments. |
|
AbstractMapOutputFile(java.lang.String fileName,
FileFormat fileFormat,
java.lang.String allVariables,
MapFormat<K,V> mapFormat)
Constructs a new map output file from the provided arguments. |
Method Summary | |
---|---|
void |
breakPoint()
Writes a line of # symbols to this file. |
void |
close()
Closes this file. |
java.lang.String |
getCanonicalName()
Returns the canonical name of this file. |
UnmodifiableSet<K> |
getFilterKeys()
Returns the set of keys whose values will be written to this output file when a map is added. |
MapFormat<K,V> |
getMapFormat()
Returns the format used to write lines to this file. |
java.lang.String |
getName()
Returns the canonical name of this file. |
java.lang.String |
getOriginalName()
Returns the name of this file. |
boolean |
isClosed()
Indicates if this file has already been closed. |
protected void |
writeLine(java.lang.String line)
Writes the provided string to this file as a line. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface sbrt.shell.io.MapOutputFile |
---|
addData |
Methods inherited from interface sbrt.kernel.io.ResultsManager |
---|
addData |
Constructor Detail |
---|
public AbstractMapOutputFile(java.lang.String fileName, FileFormat fileFormat, java.util.Set<? extends K> keys, MapFormat<K,V> mapFormat)
fileName
- the name of the file to create.fileFormat
- the format of the file to create.keys
- the keys whose values will be
written to this file. If null
, all values
from every added map will be written to this file.mapFormat
- the map format.
java.lang.NullPointerException
- if any argument except
variables
is null
.public AbstractMapOutputFile(java.lang.String fileName, FileFormat fileFormat, java.lang.String allVariables, MapFormat<K,V> mapFormat)
fileName
- the name of the file to create.fileFormat
- the format of the file to create.allVariables
- a string representation of the
variables whose values will be written to this file. This
string is parsed by the provided vector format.mapFormat
- the vector format.
java.lang.NullPointerException
- if any argument is null
.public AbstractMapOutputFile(java.lang.String fileName, FileFormat fileFormat, MapFormat<K,V> mapFormat)
fileName
- the name of the file to create.fileFormat
- the format of the file to create.mapFormat
- the map format.
java.lang.NullPointerException
- if any argument is null
.Method Detail |
---|
public UnmodifiableSet<K> getFilterKeys()
getFilterKeys
in interface MapOutputFile<K,V>
null
if every value in an added map
will be written to this file.public MapFormat<K,V> getMapFormat()
getMapFormat
in interface MapTextFile<K,V>
protected final void writeLine(java.lang.String line)
line
- the string to write as a line in this file.public void close()
close
in interface ResultsManager<java.util.Map<? extends K,? extends V>>
close
in interface SbrtFile
public final java.lang.String getName()
getName
in interface ResultsManager<java.util.Map<? extends K,? extends V>>
public final java.lang.String getOriginalName()
getOriginalName
in interface SbrtFile
public final java.lang.String getCanonicalName()
getCanonicalName
in interface SbrtFile
File.getCanonicalPath()
public boolean isClosed()
isClosed
in interface ResultsManager<java.util.Map<? extends K,? extends V>>
isClosed
in interface SbrtFile
true
if this file is closed;
false
othewise.ResultsManager.close()
public void breakPoint()
#
symbols to this file.
breakPoint
in interface ResultsManager<java.util.Map<? extends K,? extends V>>
java.lang.IllegalStateException
- if close()
has already been called.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |