Package com.csse3200.game.cutscene.models.object

Enum Class Position

java.lang.Object

java.lang.Enum<Position>

com.csse3200.game.cutscene.models.object.Position

All Implemented Interfaces:

Serializable, Comparable<Position>, Constable

public enum Position
extends Enum<Position>

The different positions a character can be displayed on screen.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LEFT	Renders default image on the left side of the screen
RIGHT	Renders flipped image on the right side of the screen

Method Summary

Modifier and Type	Method	Description
static Position	fromString(String value)	Maps JSON values "left"|"right" to their Position counterparts.
static Position	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Position[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LEFT

public static final Position LEFT

Renders default image on the left side of the screen

RIGHT

public static final Position RIGHT

Renders flipped image on the right side of the screen

Method Details

values

public static Position[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Position valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static Position fromString(String value)

Maps JSON values "left"|"right" to their Position counterparts. Default to null because invalid options are caught in validation checker.

Parameters:

value - - String value to be converted

Returns:

Position value corresponding to the input string