AstralTransRocketries/OpenComputers
1
0
Fork 0
mirror of https://github.com/MightyPirates/OpenComputers.git synced 2025-09-14 09:46:53 -04:00
Code Issues Packages Projects Releases Wiki Activity

Corrected Javadoc on a few methods.

Browse Source
This commit is contained in:
Florian Nücke 2015-04-05 17:46:11 +02:00
parent 4ba7afde8b
commit 02a13f42a5
1 changed files with 7 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/main/java/li/cil/oc/api/machine/Arguments.java
View File

@ -161,7 +161,6 @@ public interface Arguments extends Iterable<Object> {
* *
* @param index the index from which to get the argument. * @param index the index from which to get the argument.
* @return the raw value at that index. * @return the raw value at that index.
* @throws IllegalArgumentException if there is no argument at that index.
*/ */
Object optAny(int index, Object def); Object optAny(int index, Object def);
@ -173,8 +172,7 @@ public interface Arguments extends Iterable<Object> {
* *
* @param index the index from which to get the argument. * @param index the index from which to get the argument.
* @return the boolean value at the specified index. * @return the boolean value at the specified index.
* @throws IllegalArgumentException if there is no argument at that index, * @throws IllegalArgumentException if the argument exists and is not a boolean.
* or if the argument is not a boolean.
*/ */
boolean optBoolean(int index, boolean def); boolean optBoolean(int index, boolean def);
@ -186,8 +184,7 @@ public interface Arguments extends Iterable<Object> {
* *
* @param index the index from which to get the argument. * @param index the index from which to get the argument.
* @return the integer value at the specified index. * @return the integer value at the specified index.
* @throws IllegalArgumentException if there is no argument at that index, * @throws IllegalArgumentException if the argument exists but is not a number.
* or if the argument is not a number.
*/ */
int optInteger(int index, int def); int optInteger(int index, int def);
@ -199,8 +196,7 @@ public interface Arguments extends Iterable<Object> {
* *
* @param index the index from which to get the argument. * @param index the index from which to get the argument.
* @return the double value at the specified index. * @return the double value at the specified index.
* @throws IllegalArgumentException if there is no argument at that index, * @throws IllegalArgumentException if the argument exists and is not a number.
* or if the argument is not a number.
*/ */
double optDouble(int index, double def); double optDouble(int index, double def);
@ -215,8 +211,7 @@ public interface Arguments extends Iterable<Object> {
* *
* @param index the index from which to get the argument. * @param index the index from which to get the argument.
* @return the boolean value at the specified index. * @return the boolean value at the specified index.
* @throws IllegalArgumentException if there is no argument at that index, * @throws IllegalArgumentException if the argument exists and is not a string.
* or if the argument is not a string.
*/ */
String optString(int index, String def); String optString(int index, String def);
@ -228,8 +223,7 @@ public interface Arguments extends Iterable<Object> {
* *
* @param index the index from which to get the argument. * @param index the index from which to get the argument.
* @return the byte array at the specified index. * @return the byte array at the specified index.
* @throws IllegalArgumentException if there is no argument at that index, * @throws IllegalArgumentException if the argument exists and is not a byte array.
* or if the argument is not a byte array.
*/ */
byte[] optByteArray(int index, byte[] def); byte[] optByteArray(int index, byte[] def);
@ -241,8 +235,7 @@ public interface Arguments extends Iterable<Object> {
* *
* @param index the index from which to get the argument. * @param index the index from which to get the argument.
* @return the table at the specified index. * @return the table at the specified index.
* @throws IllegalArgumentException if there is no argument at that index, * @throws IllegalArgumentException if the argument exists and is not a table.
* or if the argument is not a table.
*/ */
Map optTable(int index, Map def); Map optTable(int index, Map def);
@ -254,8 +247,7 @@ public interface Arguments extends Iterable<Object> {
* *
* @param index the index from which to get the argument. * @param index the index from which to get the argument.
* @return the item stack at the specified index. * @return the item stack at the specified index.
* @throws IllegalArgumentException if there is no argument at that index, * @throws IllegalArgumentException if the argument exists and is not an item stack.
* or if the argument is not an item stack.
*/ */
ItemStack optItemStack(int index, ItemStack def); ItemStack optItemStack(int index, ItemStack def);