- java.lang.Object
-
- java.lang.Enum<Orientation>
-
- io.github.mmm.base.placement.Orientation
-
- All Implemented Interfaces:
Serializable
,Comparable<Orientation>
public enum Orientation extends Enum<Orientation>
This enum contains the available values for the orientation.- See Also:
Alignment
-
-
Enum Constant Summary
Enum Constants Enum Constant Description HORIZONTAL
A horizontal orientation means that objects are ordered from the left to the right.VERTICAL
A vertical orientation means that objects are ordered from the top to the bottom.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Orientation
fromValue(String value)
This method gets theOrientation
with the givenvalue
.Orientation
getMirrored()
This method gets the inverse orientation.String
getValue()
String
toString()
static Orientation
valueOf(String name)
Returns the enum constant of this type with the specified name.static Orientation[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
HORIZONTAL
public static final Orientation HORIZONTAL
A horizontal orientation means that objects are ordered from the left to the right.
-
VERTICAL
public static final Orientation VERTICAL
A vertical orientation means that objects are ordered from the top to the bottom.
-
-
Method Detail
-
values
public static Orientation[] 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 (Orientation c : Orientation.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Orientation 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 nameNullPointerException
- if the argument is null
-
getValue
public String getValue()
- Returns:
- the ascii symbol.
-
toString
public String toString()
- Overrides:
toString
in classEnum<Orientation>
-
fromValue
public static Orientation fromValue(String value)
This method gets theOrientation
with the givenvalue
.- Parameters:
value
- is thevalue
of the requestedOrientation
.- Returns:
- the requested
Orientation
.
-
getMirrored
public Orientation getMirrored()
This method gets the inverse orientation.- Returns:
VERTICAL
if this orientation isHORIZONTAL
and vice versa.
-
-