FileIOUtility

java.lang.Object
- edu.stanford.math.plex4.io.FileIOUtility

```
public class FileIOUtility
extends java.lang.Object
```
This class contains various static functions for reading and writing files of different types.

Author:

Tim Harrington, Andrew Tausz

Constructor Summary

Constructors
Constructor and Description

FileIOUtility()

Constructors
Constructor and Description
`FileIOUtility()`

Method Summary

Methods
Modifier and Type	Method and Description
`static java.lang.Object`	`loadObject(java.lang.String inputPath)`
`static Table`	`readCSVFile(java.lang.String filename, java.lang.String separator, boolean readTitle, boolean readHeadings)` This function reads a CSV file and outputs the values into a Table object.
`static java.util.List<double[]>`	`readNumericCSVFile(java.lang.String filename, java.lang.String separator)`
`static void`	`saveImage(java.awt.image.BufferedImage image, java.lang.String filePath)` Saves a BufferedImage stream in PNG format.
`static void`	`serializeObject(java.lang.Object obj, java.lang.String destPath)` Try to save an object for quick reloading later.
`static void`	`writeTextFile(java.lang.String filePath, java.lang.String contents, boolean append)` This function saves a string to a text file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FileIOUtility
```
public FileIOUtility()
```
- Method Detail
  - saveImage
```
public static void saveImage(java.awt.image.BufferedImage image,
             java.lang.String filePath)
                      throws java.io.IOException
```
    Saves a BufferedImage stream in PNG format.
    
    Parameters:
    image - the buffered image to save to disk
    filePath - the file to save the image file in
    
    Throws:
    
    java.io.IOException
  - writeTextFile
```
public static void writeTextFile(java.lang.String filePath,
                 java.lang.String contents,
                 boolean append)
                          throws java.io.IOException
```
    This function saves a string to a text file.
    
    Parameters:
    filePath - the path of the file to write to
    contents - a string holding the contents to write
    append - if true, then the file will be appended to
    
    Throws:
    
    java.io.IOException
  - readCSVFile
```
public static Table readCSVFile(java.lang.String filename,
                java.lang.String separator,
                boolean readTitle,
                boolean readHeadings)
                         throws java.io.IOException
```
    This function reads a CSV file and outputs the values into a Table object. The format of the file is as follows: [] [<Heading1, ..., HeadingN>] <Entry11, ..., Entry1N> <EntryM1, ..., EntryMN> The input argument readTitle should be true if and only if the file contains a title on its first line. The input argument readHeadings should be true if and only if the file contains the column headings on the file just before the first data row. Columns are assumed to be separated by the specified separator, and rows are assumed to be separated by a newline.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - the filename of the file to read from</dd><dd><code>separator</code> - the separator between columns</dd><dd><code>readTitle</code> - should be true iff the file contains a title</dd><dd><code>readHeadings</code> - should be true iff the file contains the column headings</dd> <dt><span class="strong">Returns:</span></dt><dd>a Table object containing the contents of the file</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="readNumericCSVFile(java.lang.String, java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>readNumericCSVFile</h4> <pre>public static java.util.List<double[]> readNumericCSVFile(java.lang.String filename, java.lang.String separator) throws java.io.IOException</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="serializeObject(java.lang.Object, java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>serializeObject</h4> <pre>public static void serializeObject(java.lang.Object obj, java.lang.String destPath) throws java.io.IOException</pre> <div class="block">Try to save an object for quick reloading later.</div> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.Exception</code></dd> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="loadObject(java.lang.String)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>loadObject</h4> <pre>public static java.lang.Object loadObject(java.lang.String inputPath) throws java.io.IOException</pre> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputPath</code> - </dd> <dt><span class="strong">Returns:</span></dt><dd>a deserialized object loaded from inputPath</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.Exception</code></dd> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <div class="bottomNav"><a name="navbar_bottom">  </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">  </a> <ul class="navList" title="Navigation"> <li><a href="../../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../../index-all.html">Index</a></li> <li><a href="../../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../edu/stanford/math/plex4/io/DoubleArrayReaderWriter.html" title="class in edu.stanford.math.plex4.io"><span class="strong">PREV CLASS</span></a></li> <li><a href="../../../../../edu/stanford/math/plex4/io/FileManager.html" title="class in edu.stanford.math.plex4.io"><span class="strong">NEXT CLASS</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?edu/stanford/math/plex4/io/FileIOUtility.html" target="_top">FRAMES</a></li> <li><a href="FileIOUtility.html" target="_top">NO FRAMES</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"> </script> </div> <div> <ul class="subNavList"> <li>SUMMARY: </li> <li>NESTED | </li> <li>FIELD | </li> <li><a href="#constructor_summary">CONSTR</a> | </li> <li><a href="#method_summary">METHOD</a></li> </ul> <ul class="subNavList"> <li>DETAIL: </li> <li>FIELD | </li> <li><a href="#constructor_detail">CONSTR</a> | </li> <li><a href="#method_detail">METHOD</a></li> </ul> </div> <a name="skip-navbar_bottom">  </a></div>  </body> </html>

Class FileIOUtility

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileIOUtility

Method Detail

saveImage

writeTextFile

readCSVFile