com.github.strikerx3.jxinput.enums

Enum XInputBatteryLevel

java.lang.Object

java.lang.Enum<XInputBatteryLevel>

com.github.strikerx3.jxinput.enums.XInputBatteryLevel

All Implemented Interfaces:

Serializable, Comparable<XInputBatteryLevel>

public enum XInputBatteryLevel
extends Enum<XInputBatteryLevel>

Enumerates all XInput battery levels.

Author:

Ivan "StrikerX3" Oliveira

Enum Constant Summary

Enum Constants

Enum Constant and Description
EMPTY
FULL
LOW
MEDIUM

Method Summary

Modifier and Type	Method and Description
static XInputBatteryLevel	fromNative(byte value) Retrieves the appropriate enum value from the native value.
static XInputBatteryLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static XInputBatteryLevel[]	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

EMPTY

public static final XInputBatteryLevel EMPTY

LOW

public static final XInputBatteryLevel LOW

MEDIUM

public static final XInputBatteryLevel MEDIUM

FULL

public static final XInputBatteryLevel FULL

Method Detail

values

public static XInputBatteryLevel[] 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 (XInputBatteryLevel c : XInputBatteryLevel.values())
    System.out.println(c);

Returns:

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

valueOf

public static XInputBatteryLevel 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 XInputBatteryLevel 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