com.github.strikerx3.jxinput.enums

Enum XInputBatteryType

java.lang.Object

java.lang.Enum<XInputBatteryType>

com.github.strikerx3.jxinput.enums.XInputBatteryType

All Implemented Interfaces:

Serializable, Comparable<XInputBatteryType>

public enum XInputBatteryType
extends Enum<XInputBatteryType>

Enumerates all XInput battery types.

Author:

Ivan "StrikerX3" Oliveira

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALKALINE
DISCONNECTED
NIMH
UNKNOWN
WIRED

Method Summary

Modifier and Type	Method and Description
static XInputBatteryType	fromNative(byte value) Retrieves the appropriate enum value from the native value.
static XInputBatteryType	valueOf(String name) Returns the enum constant of this type with the specified name.
static XInputBatteryType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISCONNECTED

public static final XInputBatteryType DISCONNECTED

WIRED

public static final XInputBatteryType WIRED

ALKALINE

public static final XInputBatteryType ALKALINE

NIMH

public static final XInputBatteryType NIMH

UNKNOWN

public static final XInputBatteryType UNKNOWN

Method Detail

values

public static XInputBatteryType[] values()

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:

for (XInputBatteryType c : XInputBatteryType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static XInputBatteryType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromNative

public static XInputBatteryType fromNative(byte value)

Retrieves the appropriate enum value from the native value.

Parameters:

value - the native value

Returns:

the corresponding enum constant

Throws:

IllegalArgumentException - if the given native value does not correspond to an enum value