<!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_21) on Tue May 14 01:28:32 CEST 2013 --> <title>Updater.UpdateResult</title> <meta name="date" content="2013-05-14"> <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="Updater.UpdateResult"; } //--> </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/Updater.UpdateResult.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="../../../../com/comphenix/protocol/metrics/Updater.html" title="class in com.comphenix.protocol.metrics"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateType.html" title="enum in com.comphenix.protocol.metrics"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/comphenix/protocol/metrics/Updater.UpdateResult.html" target="_top">Frames</a></li> <li><a href="Updater.UpdateResult.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">com.comphenix.protocol.metrics</div> <h2 title="Enum Updater.UpdateResult" class="title">Enum Updater.UpdateResult</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>java.lang.Enum<<a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a>></li> <li> <ul class="inheritance"> <li>com.comphenix.protocol.metrics.Updater.UpdateResult</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="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a>></dd> </dl> <dl> <dt>Enclosing class:</dt> <dd><a href="../../../../com/comphenix/protocol/metrics/Updater.html" title="class in com.comphenix.protocol.metrics">Updater</a></dd> </dl> <hr> <br> <pre>public static enum <span class="strong">Updater.UpdateResult</span> extends java.lang.Enum<<a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a>></pre> <div class="block">Gives the dev the result of the update process. Can be obtained by called getResult().</div> </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="overviewSummary" 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><strong><a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html#FAIL_BADSLUG">FAIL_BADSLUG</a></strong></code> <div class="block">The slug provided by the plugin running the updater was invalid and doesn't exist on DBO.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html#FAIL_DBO">FAIL_DBO</a></strong></code> <div class="block">For some reason, the updater was unable to contact dev.bukkit.org to download the file.</div> </td> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html#FAIL_DOWNLOAD">FAIL_DOWNLOAD</a></strong></code> <div class="block">The updater found an update, but was unable to download it.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html#FAIL_NOVERSION">FAIL_NOVERSION</a></strong></code> <div class="block">When running the version check, the file on DBO did not contain the a version in the format 'vVersion' such as 'v1.0'.</div> </td> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html#NO_UPDATE">NO_UPDATE</a></strong></code> <div class="block">The updater did not find an update, and nothing was downloaded.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html#NOT_SUPPORTED">NOT_SUPPORTED</a></strong></code> <div class="block">Updating SNAPSHOT versions are not supported.</div> </td> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html#SUCCESS">SUCCESS</a></strong></code> <div class="block">The updater found an update, and has readied it to be loaded the next time the server restarts/reloads.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html#UPDATE_AVAILABLE">UPDATE_AVAILABLE</a></strong></code> <div class="block">The updater found an update, but because of the UpdateType being set to NO_DOWNLOAD, it wasn't downloaded.</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"> </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>static <a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html#getResult(int)">getResult</a></strong>(int value)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html#getValue()">getValue</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html#toString()">toString</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> <div class="block">Returns the enum constant of this type with the specified name.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a>[]</code></td> <td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html#values()">values</a></strong>()</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>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, 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="SUCCESS"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>SUCCESS</h4> <pre>public static final <a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a> SUCCESS</pre> <div class="block">The updater found an update, and has readied it to be loaded the next time the server restarts/reloads.</div> </li> </ul> <a name="NO_UPDATE"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>NO_UPDATE</h4> <pre>public static final <a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a> NO_UPDATE</pre> <div class="block">The updater did not find an update, and nothing was downloaded.</div> </li> </ul> <a name="FAIL_DOWNLOAD"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>FAIL_DOWNLOAD</h4> <pre>public static final <a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a> FAIL_DOWNLOAD</pre> <div class="block">The updater found an update, but was unable to download it.</div> </li> </ul> <a name="FAIL_DBO"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>FAIL_DBO</h4> <pre>public static final <a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a> FAIL_DBO</pre> <div class="block">For some reason, the updater was unable to contact dev.bukkit.org to download the file.</div> </li> </ul> <a name="FAIL_NOVERSION"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>FAIL_NOVERSION</h4> <pre>public static final <a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a> FAIL_NOVERSION</pre> <div class="block">When running the version check, the file on DBO did not contain the a version in the format 'vVersion' such as 'v1.0'.</div> </li> </ul> <a name="FAIL_BADSLUG"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>FAIL_BADSLUG</h4> <pre>public static final <a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a> FAIL_BADSLUG</pre> <div class="block">The slug provided by the plugin running the updater was invalid and doesn't exist on DBO.</div> </li> </ul> <a name="UPDATE_AVAILABLE"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>UPDATE_AVAILABLE</h4> <pre>public static final <a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a> UPDATE_AVAILABLE</pre> <div class="block">The updater found an update, but because of the UpdateType being set to NO_DOWNLOAD, it wasn't downloaded.</div> </li> </ul> <a name="NOT_SUPPORTED"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>NOT_SUPPORTED</h4> <pre>public static final <a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a> NOT_SUPPORTED</pre> <div class="block">Updating SNAPSHOT versions are not supported. Please perform a manual upgrade.</div> </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="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</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 (Updater.UpdateResult c : Updater.UpdateResult.values()) System.out.println(c); </pre></div> <dl><dt><span class="strong">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="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</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="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> <dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> <dt><span class="strong">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="getValue()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getValue</h4> <pre>public int getValue()</pre> </li> </ul> <a name="getResult(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getResult</h4> <pre>public static <a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a> getResult(int value)</pre> </li> </ul> <a name="toString()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> <pre>public java.lang.String toString()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>toString</code> in class <code>java.lang.Enum<<a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateResult.html" title="enum in com.comphenix.protocol.metrics">Updater.UpdateResult</a>></code></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><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/Updater.UpdateResult.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="../../../../com/comphenix/protocol/metrics/Updater.html" title="class in com.comphenix.protocol.metrics"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/comphenix/protocol/metrics/Updater.UpdateType.html" title="enum in com.comphenix.protocol.metrics"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/comphenix/protocol/metrics/Updater.UpdateResult.html" target="_top">Frames</a></li> <li><a href="Updater.UpdateResult.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>