blob: d24fac01bf6da6c0c6ff1d29a949560241789b3c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Tue Aug 30 09:58:51 EDT 2016 -->
<title>LocalFileSystemStore</title>
<meta name="date" content="2016-08-30">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="LocalFileSystemStore";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_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="class-use/LocalFileSystemStore.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/pirk/serialization/JsonSerializer.html" title="class in org.apache.pirk.serialization"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/pirk/serialization/SerializationService.html" title="class in org.apache.pirk.serialization"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/pirk/serialization/LocalFileSystemStore.html" target="_top">Frames</a></li>
<li><a href="LocalFileSystemStore.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.pirk.serialization</div>
<h2 title="Class LocalFileSystemStore" class="title">Class LocalFileSystemStore</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.pirk.serialization.LocalFileSystemStore</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">LocalFileSystemStore</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/pirk/serialization/LocalFileSystemStore.html#LocalFileSystemStore()">LocalFileSystemStore</a></strong>()</code>
<div class="block">Creates a new storage service on the local file system using default Java serialization.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/pirk/serialization/LocalFileSystemStore.html#LocalFileSystemStore(org.apache.pirk.serialization.SerializationService)">LocalFileSystemStore</a></strong>(<a href="../../../../org/apache/pirk/serialization/SerializationService.html" title="class in org.apache.pirk.serialization">SerializationService</a>&nbsp;serial)</code>
<div class="block">Creates a new storage service on the local file system using the given serializer.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/serialization/LocalFileSystemStore.html#recall(java.io.File,%20java.lang.Class)">recall</a></strong>(java.io.File&nbsp;file,
java.lang.Class&lt;T&gt;&nbsp;type)</code>
<div class="block">Returns the object stored in the local file system at the given file location.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/serialization/LocalFileSystemStore.html#recall(java.lang.String,%20java.lang.Class)">recall</a></strong>(java.lang.String&nbsp;path,
java.lang.Class&lt;T&gt;&nbsp;type)</code>
<div class="block">Returns the object stored in the local file system at the given path.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/serialization/LocalFileSystemStore.html#setSerializer(org.apache.pirk.serialization.SerializationService)">setSerializer</a></strong>(<a href="../../../../org/apache/pirk/serialization/SerializationService.html" title="class in org.apache.pirk.serialization">SerializationService</a>&nbsp;service)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/serialization/LocalFileSystemStore.html#store(java.io.File,%20org.apache.pirk.serialization.Storable)">store</a></strong>(java.io.File&nbsp;file,
<a href="../../../../org/apache/pirk/serialization/Storable.html" title="interface in org.apache.pirk.serialization">Storable</a>&nbsp;obj)</code>
<div class="block">Stores the given object at the given file location.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pirk/serialization/LocalFileSystemStore.html#store(java.lang.String,%20org.apache.pirk.serialization.Storable)">store</a></strong>(java.lang.String&nbsp;path,
<a href="../../../../org/apache/pirk/serialization/Storable.html" title="interface in org.apache.pirk.serialization">Storable</a>&nbsp;obj)</code>
<div class="block">Stores the given object at the given path.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="LocalFileSystemStore()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LocalFileSystemStore</h4>
<pre>public&nbsp;LocalFileSystemStore()</pre>
<div class="block">Creates a new storage service on the local file system using default Java serialization.</div>
</li>
</ul>
<a name="LocalFileSystemStore(org.apache.pirk.serialization.SerializationService)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LocalFileSystemStore</h4>
<pre>public&nbsp;LocalFileSystemStore(<a href="../../../../org/apache/pirk/serialization/SerializationService.html" title="class in org.apache.pirk.serialization">SerializationService</a>&nbsp;serial)</pre>
<div class="block">Creates a new storage service on the local file system using the given serializer.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="store(java.lang.String, org.apache.pirk.serialization.Storable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>store</h4>
<pre>public&nbsp;void&nbsp;store(java.lang.String&nbsp;path,
<a href="../../../../org/apache/pirk/serialization/Storable.html" title="interface in org.apache.pirk.serialization">Storable</a>&nbsp;obj)
throws java.io.IOException</pre>
<div class="block">Stores the given object at the given path. The object is serialized using the configured serializer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - The local file system path.</dd><dd><code>obj</code> - The object to store.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If a problem occurs storing the object.</dd></dl>
</li>
</ul>
<a name="store(java.io.File, org.apache.pirk.serialization.Storable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>store</h4>
<pre>public&nbsp;void&nbsp;store(java.io.File&nbsp;file,
<a href="../../../../org/apache/pirk/serialization/Storable.html" title="interface in org.apache.pirk.serialization">Storable</a>&nbsp;obj)
throws java.io.IOException</pre>
<div class="block">Stores the given object at the given file location. The object is serialized using the configured serializer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - The local file system location to store the object.</dd><dd><code>obj</code> - The object to store.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If a problem occurs storing the object.</dd></dl>
</li>
</ul>
<a name="recall(java.lang.String, java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recall</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;T&nbsp;recall(java.lang.String&nbsp;path,
java.lang.Class&lt;T&gt;&nbsp;type)
throws java.io.IOException</pre>
<div class="block">Returns the object stored in the local file system at the given path.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - The local file system path.</dd><dd><code>type</code> - The type of object being retrieved.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The object retrieved from the store.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If a problem occurs retrieving the object.</dd></dl>
</li>
</ul>
<a name="recall(java.io.File, java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recall</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;T&nbsp;recall(java.io.File&nbsp;file,
java.lang.Class&lt;T&gt;&nbsp;type)
throws java.io.IOException</pre>
<div class="block">Returns the object stored in the local file system at the given file location.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - The local file system location.</dd><dd><code>type</code> - The type of object being retrieved.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The object retrieved from the store.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If a problem occurs retrieving the object.</dd></dl>
</li>
</ul>
<a name="setSerializer(org.apache.pirk.serialization.SerializationService)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setSerializer</h4>
<pre>public&nbsp;void&nbsp;setSerializer(<a href="../../../../org/apache/pirk/serialization/SerializationService.html" title="class in org.apache.pirk.serialization">SerializationService</a>&nbsp;service)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<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="class-use/LocalFileSystemStore.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/pirk/serialization/JsonSerializer.html" title="class in org.apache.pirk.serialization"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/pirk/serialization/SerializationService.html" title="class in org.apache.pirk.serialization"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/pirk/serialization/LocalFileSystemStore.html" target="_top">Frames</a></li>
<li><a href="LocalFileSystemStore.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"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>