diff options
| author | Eduardo Pedroni <e.pedroni91@gmail.com> | 2014-10-18 15:21:45 +0200 |
|---|---|---|
| committer | Eduardo Pedroni <e.pedroni91@gmail.com> | 2014-10-18 15:21:45 +0200 |
| commit | 4f26361eb08aa09334d1eea0a124110c20d809ce (patch) | |
| tree | ea2652193f376eee5c9c44776895378b123be7c8 /doc/jcgp/backend/parameters/ParameterStatus.html | |
| parent | fc0f9ce2aa46444ff69e89e9b9e09f3610eedd74 (diff) | |
Moved javadocs to a different repository for hosting, updated README
Diffstat (limited to 'doc/jcgp/backend/parameters/ParameterStatus.html')
| -rw-r--r-- | doc/jcgp/backend/parameters/ParameterStatus.html | 432 |
1 files changed, 0 insertions, 432 deletions
diff --git a/doc/jcgp/backend/parameters/ParameterStatus.html b/doc/jcgp/backend/parameters/ParameterStatus.html deleted file mode 100644 index 981df8e..0000000 --- a/doc/jcgp/backend/parameters/ParameterStatus.html +++ /dev/null @@ -1,432 +0,0 @@ -<!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_05) on Thu May 22 06:02:30 BST 2014 --> -<title>ParameterStatus</title> -<meta name="date" content="2014-05-22"> -<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="ParameterStatus"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10,"i2":9,"i3":9}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="../../../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/ParameterStatus.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="../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters"><span class="typeNameLink">Prev Class</span></a></li> -<li>Next Class</li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?jcgp/backend/parameters/ParameterStatus.html" target="_top">Frames</a></li> -<li><a href="ParameterStatus.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="#enum.constant.summary">Enum Constants</a> | </li> -<li>Field | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li><a href="#enum.constant.detail">Enum Constants</a> | </li> -<li>Field | </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">jcgp.backend.parameters</div> -<h2 title="Enum ParameterStatus" class="title">Enum ParameterStatus</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>java.lang.Enum<<a href="../../../jcgp/backend/parameters/ParameterStatus.html" title="enum in jcgp.backend.parameters">ParameterStatus</a>></li> -<li> -<ul class="inheritance"> -<li>jcgp.backend.parameters.ParameterStatus</li> -</ul> -</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Implemented Interfaces:</dt> -<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../jcgp/backend/parameters/ParameterStatus.html" title="enum in jcgp.backend.parameters">ParameterStatus</a>></dd> -</dl> -<hr> -<br> -<pre>public enum <span class="typeNameLabel">ParameterStatus</span> -extends java.lang.Enum<<a href="../../../jcgp/backend/parameters/ParameterStatus.html" title="enum in jcgp.backend.parameters">ParameterStatus</a>></pre> -<div class="block">Enum type containing all possible states for parameters. - <br> - <ul> - <li>INVALID: the new parameter value is not valid, - and the experiment will not be allowed to run.</li> - <li>WARNING: the new parameter value is technically valid, - though it might lead to undesirable behaviour.</li> - <li>WARNING_RESET: the new parameter value is technically valid - but will require a reset.</li> - <li>VALID: the new value is valid.</li> - </ul> - <br><br> - The above definitions are final in the sense that they outline - how parameters are treated by the program depending on their - status (e.g. if any parameters are set to WARNING_RESET, a reset - will automatically be performed when the experiment is run). - <br> - In addition to the status itself, this class includes a field - to contain details about the current status. If a GUI is in use, - the contents of the field should be displayed to the user, as well - as some visual indication of the status itself. Both the status - and the message should be updated by each parameter when <code>validate()</code> - is called.</div> -<dl> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd>Eduardo Pedroni</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters"><code>Parameter</code></a></dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- =========== ENUM CONSTANT SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="enum.constant.summary"> -<!-- --> -</a> -<h3>Enum Constant Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> -<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Enum Constant and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../jcgp/backend/parameters/ParameterStatus.html#INVALID">INVALID</a></span></code> </td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../jcgp/backend/parameters/ParameterStatus.html#VALID">VALID</a></span></code> </td> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../jcgp/backend/parameters/ParameterStatus.html#WARNING">WARNING</a></span></code> </td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../jcgp/backend/parameters/ParameterStatus.html#WARNING_RESET">WARNING_RESET</a></span></code> </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/parameters/ParameterStatus.html#getDetails--">getDetails</a></span>()</code> </td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/parameters/ParameterStatus.html#setDetails-java.lang.String-">setDetails</a></span>(java.lang.String details)</code> -<div class="block">Sets a new string containing details about the current status.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>static <a href="../../../jcgp/backend/parameters/ParameterStatus.html" title="enum in jcgp.backend.parameters">ParameterStatus</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/parameters/ParameterStatus.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String name)</code> -<div class="block">Returns the enum constant of this type with the specified name.</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>static <a href="../../../jcgp/backend/parameters/ParameterStatus.html" title="enum in jcgp.backend.parameters">ParameterStatus</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/parameters/ParameterStatus.html#values--">values</a></span>()</code> -<div class="block">Returns an array containing the constants of this enum type, in -the order they are declared.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.Enum</h3> -<code>compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> -</ul> -<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>getClass, notify, notifyAll, wait, wait, wait</code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ ENUM CONSTANT DETAIL =========== --> -<ul class="blockList"> -<li class="blockList"><a name="enum.constant.detail"> -<!-- --> -</a> -<h3>Enum Constant Detail</h3> -<a name="INVALID"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>INVALID</h4> -<pre>public static final <a href="../../../jcgp/backend/parameters/ParameterStatus.html" title="enum in jcgp.backend.parameters">ParameterStatus</a> INVALID</pre> -</li> -</ul> -<a name="WARNING"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>WARNING</h4> -<pre>public static final <a href="../../../jcgp/backend/parameters/ParameterStatus.html" title="enum in jcgp.backend.parameters">ParameterStatus</a> WARNING</pre> -</li> -</ul> -<a name="WARNING_RESET"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>WARNING_RESET</h4> -<pre>public static final <a href="../../../jcgp/backend/parameters/ParameterStatus.html" title="enum in jcgp.backend.parameters">ParameterStatus</a> WARNING_RESET</pre> -</li> -</ul> -<a name="VALID"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>VALID</h4> -<pre>public static final <a href="../../../jcgp/backend/parameters/ParameterStatus.html" title="enum in jcgp.backend.parameters">ParameterStatus</a> VALID</pre> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="values--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>values</h4> -<pre>public static <a href="../../../jcgp/backend/parameters/ParameterStatus.html" title="enum in jcgp.backend.parameters">ParameterStatus</a>[] values()</pre> -<div class="block">Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -<pre> -for (ParameterStatus c : ParameterStatus.values()) - System.out.println(c); -</pre></div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>an array containing the constants of this enum type, in the order they are declared</dd> -</dl> -</li> -</ul> -<a name="valueOf-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>valueOf</h4> -<pre>public static <a href="../../../jcgp/backend/parameters/ParameterStatus.html" title="enum in jcgp.backend.parameters">ParameterStatus</a> valueOf(java.lang.String name)</pre> -<div class="block">Returns the enum constant of this type with the specified name. -The string must match <i>exactly</i> an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>name</code> - the name of the enum constant to be returned.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the enum constant with the specified name</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> -<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd> -</dl> -</li> -</ul> -<a name="setDetails-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setDetails</h4> -<pre>public void setDetails(java.lang.String details)</pre> -<div class="block">Sets a new string containing details about the current status. - This should be displayed by the GUI, if one is in use.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>details</code> - an explanation of the current status.</dd> -</dl> -</li> -</ul> -<a name="getDetails--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>getDetails</h4> -<pre>public java.lang.String getDetails()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the string containing details about the current status.</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="../../../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/ParameterStatus.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="../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters"><span class="typeNameLink">Prev Class</span></a></li> -<li>Next Class</li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?jcgp/backend/parameters/ParameterStatus.html" target="_top">Frames</a></li> -<li><a href="ParameterStatus.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="#enum.constant.summary">Enum Constants</a> | </li> -<li>Field | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li><a href="#enum.constant.detail">Enum Constants</a> | </li> -<li>Field | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> |