|
- <!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 (1.8.0_131) on Mon Jun 05 21:49:34 MST 2017 -->
- <title>UserFactory (LibrarySystem - BinHong Lee)</title>
- <meta name="date" content="2017-06-05">
- <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
- <script type="text/javascript" src="../script.js"></script>
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="UserFactory (LibrarySystem - BinHong Lee)";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
- var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
- var altColor = "altColor";
- var rowColor = "rowColor";
- var tableTab = "tableTab";
- var activeTableTab = "activeTableTab";
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar.top">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.top.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../libsys/package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="package-tree.html">Tree</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="../libsys/User.html" title="class in libsys"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../libsys/UserFactoryTest.html" title="class in libsys"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../index.html?libsys/UserFactory.html" target="_top">Frames</a></li>
- <li><a href="UserFactory.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: </li>
- <li>Nested | </li>
- <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </li>
- <li><a href="#constructor.detail">Constr</a> | </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">libsys</div>
- <h2 title="Class UserFactory" class="title">Class UserFactory</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li>libsys.UserFactory</li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <hr>
- <br>
- <pre>public class <span class="typeNameLabel">UserFactory</span>
- extends java.lang.Object</pre>
- <div class="block">Handles all the User(s)</div>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- =========== FIELD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="field.summary">
- <!-- -->
- </a>
- <h3>Field Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
- <caption><span>Fields</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Field and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>private int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/UserFactory.html#id">id</a></span></code> </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>private java.lang.String</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/UserFactory.html#userFilename">userFilename</a></span></code> </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>private java.util.List<<a href="../libsys/User.html" title="class in libsys">User</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/UserFactory.html#users">users</a></span></code> </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.summary">
- <!-- -->
- </a>
- <h3>Constructor Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
- <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colOne" scope="col">Constructor and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colOne"><code><span class="memberNameLink"><a href="../libsys/UserFactory.html#UserFactory--">UserFactory</a></span>()</code>
- <div class="block">Create a new empty UserFactory</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colOne"><code><span class="memberNameLink"><a href="../libsys/UserFactory.html#UserFactory-java.lang.String-">UserFactory</a></span>(java.lang.String userFilename)</code>
- <div class="block">Create a new UserFactory and fill it with information from a JSON file</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Method and Description</th>
- </tr>
- <tr id="i0" class="altColor">
- <td class="colFirst"><code>(package private) <a href="../libsys/User.html" title="class in libsys">User</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/UserFactory.html#getUser-int-">getUser</a></span>(int index)</code>
- <div class="block">Looks for a User with the given id</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code><a href="../libsys/User.html" title="class in libsys">User</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/UserFactory.html#getUser-java.lang.String-">getUser</a></span>(java.lang.String name)</code>
- <div class="block">Looks for the User with the given name</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code>(package private) <a href="../libsys/User.html" title="class in libsys">User</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/UserFactory.html#newUser-java.lang.String-int-">newUser</a></span>(java.lang.String name,
- int limit)</code>
- <div class="block">Adds a new User into this class</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code>private <a href="../libsys/User.html" title="class in libsys">User</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/UserFactory.html#search-int-int-int-">search</a></span>(int index,
- int start,
- int end)</code>
- <div class="block">Recursive binary search through the array list for the User with the given id</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code>(package private) void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/UserFactory.html#setUserFileName-java.lang.String-">setUserFileName</a></span>(java.lang.String userFilename)</code>
- <div class="block">Update the output filename for the object</div>
- </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code>(package private) void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/UserFactory.html#toJsonFile--">toJsonFile</a></span>()</code>
- <div class="block">Output the data into a JSON file replacing the input file (or if filename not given, "users.json")</div>
- </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../libsys/UserFactory.html#update-libsys.User-libsys.User-">update</a></span>(<a href="../libsys/User.html" title="class in libsys">User</a> oldUser,
- <a href="../libsys/User.html" title="class in libsys">User</a> newUser)</code>
- <div class="block">Replacing a User in the array list with a new User</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 java.lang.Object</h3>
- <code>clone, equals, finalize, 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">
- <!-- ============ FIELD DETAIL =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="field.detail">
- <!-- -->
- </a>
- <h3>Field Detail</h3>
- <a name="id">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>id</h4>
- <pre>private int id</pre>
- </li>
- </ul>
- <a name="userFilename">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>userFilename</h4>
- <pre>private java.lang.String userFilename</pre>
- </li>
- </ul>
- <a name="users">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>users</h4>
- <pre>private java.util.List<<a href="../libsys/User.html" title="class in libsys">User</a>> users</pre>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a name="UserFactory--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>UserFactory</h4>
- <pre>public UserFactory()</pre>
- <div class="block">Create a new empty UserFactory</div>
- </li>
- </ul>
- <a name="UserFactory-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>UserFactory</h4>
- <pre>public UserFactory(java.lang.String userFilename)</pre>
- <div class="block">Create a new UserFactory and fill it with information from a JSON file</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>userFilename</code> - Name of the input JSON file</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="getUser-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getUser</h4>
- <pre><a href="../libsys/User.html" title="class in libsys">User</a> getUser(int index)</pre>
- <div class="block">Looks for a User with the given id</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>index</code> - id of the User to be found</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>User with the given id</dd>
- </dl>
- </li>
- </ul>
- <a name="getUser-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getUser</h4>
- <pre>public <a href="../libsys/User.html" title="class in libsys">User</a> getUser(java.lang.String name)</pre>
- <div class="block">Looks for the User with the given name</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>name</code> - Name of the User to be found</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>User with the given name</dd>
- </dl>
- </li>
- </ul>
- <a name="newUser-java.lang.String-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>newUser</h4>
- <pre><a href="../libsys/User.html" title="class in libsys">User</a> newUser(java.lang.String name,
- int limit)</pre>
- <div class="block">Adds a new User into this class</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>name</code> - Name of the User</dd>
- <dd><code>limit</code> - Limit of Book the User can borrow</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The new User that is just created</dd>
- </dl>
- </li>
- </ul>
- <a name="search-int-int-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>search</h4>
- <pre>private <a href="../libsys/User.html" title="class in libsys">User</a> search(int index,
- int start,
- int end)</pre>
- <div class="block">Recursive binary search through the array list for the User with the given id</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>index</code> - id of the User to be found</dd>
- <dd><code>start</code> - Starting point to search</dd>
- <dd><code>end</code> - Ending point to search</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>User with the given id</dd>
- </dl>
- </li>
- </ul>
- <a name="setUserFileName-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setUserFileName</h4>
- <pre>void setUserFileName(java.lang.String userFilename)</pre>
- <div class="block">Update the output filename for the object</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>userFilename</code> - The new filename</dd>
- </dl>
- </li>
- </ul>
- <a name="toJsonFile--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>toJsonFile</h4>
- <pre>void toJsonFile()</pre>
- <div class="block">Output the data into a JSON file replacing the input file (or if filename not given, "users.json")</div>
- </li>
- </ul>
- <a name="update-libsys.User-libsys.User-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>update</h4>
- <pre>public void update(<a href="../libsys/User.html" title="class in libsys">User</a> oldUser,
- <a href="../libsys/User.html" title="class in libsys">User</a> newUser)</pre>
- <div class="block">Replacing a User in the array list with a new User</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>oldUser</code> - User to be replaced</dd>
- <dd><code>newUser</code> - User replacing it</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- </div>
- <!-- ========= END OF CLASS DATA ========= -->
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a name="navbar.bottom">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.bottom.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../libsys/package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="package-tree.html">Tree</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="../libsys/User.html" title="class in libsys"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../libsys/UserFactoryTest.html" title="class in libsys"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../index.html?libsys/UserFactory.html" target="_top">Frames</a></li>
- <li><a href="UserFactory.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: </li>
- <li>Nested | </li>
- <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- </body>
- </html>
|