Package nl.pim16aap2.animatedarchitecture.core.structures.properties

Enum Class PropertyAccessLevel

java.lang.Object

java.lang.Enum<PropertyAccessLevel>

nl.pim16aap2.animatedarchitecture.core.structures.properties.PropertyAccessLevel

All Implemented Interfaces:

Serializable, Comparable<PropertyAccessLevel>, Constable

public enum PropertyAccessLevel
extends Enum<PropertyAccessLevel>

Represents the access level of a property.

This determines to what extent a user can interact with the property.

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
HIDDEN	The property is hidden from the user.
USER_EDITABLE	The property is editable by the user.
VISIBLE	The property is visible to the user but not directly editable.

Method Summary

Modifier and Type	Method	Description
static PropertyAccessLevel	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PropertyAccessLevel[]	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

HIDDEN

public static final PropertyAccessLevel HIDDEN

The property is hidden from the user.

It will not be shown in the GUI or in any other user-facing interface.

This is useful for properties that are only used strictly internally.

VISIBLE

public static final PropertyAccessLevel VISIBLE

The property is visible to the user but not directly editable.

It may be shown in the GUI and in any other user-facing interface.

This is useful for properties that the user should be able to see but not change directly.

USER_EDITABLE

public static final PropertyAccessLevel USER_EDITABLE

The property is editable by the user.

The user can directly change the value of this property.

Method Details

values

public static PropertyAccessLevel[] 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 PropertyAccessLevel 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