Package manifold.ext.props.rt.api

Enum PropOption

java.lang.Object

java.lang.Enum<PropOption>

manifold.ext.props.rt.api.PropOption

All Implemented Interfaces:

Serializable, Comparable<PropOption>

public enum PropOption
extends Enum<PropOption>

Options used with val, {@link var}, get, set.

Note, usage with val and {@link var} should normally be limited to Package. Other options pertain to get or set to override the declared modifiers on {@link var} orval e.g.,

    // only the setter method is abstract
   @var @set(Abstract) String name;
 

Enum Constant Summary

Enum Constants

Enum Constant	Description
Abstract	For use with get, set to override the non-use of abstract modifier on a @var property, or individually with get and set.
Final	For use with get, set to override the non-use of final modifier on a @var property, or individually with get and set.
Package	For use with {@link var}, get, set to override the property's declared accessibility.
Private	For use with get, set to override the property's declared accessibility.
Protected	For use with get, set to override the property's declared accessibility.
Public	For use with get, set to override the property's declared accessibility.

Method Summary

Modifier and Type	Method	Description
static PropOption	fromModifier(int modifier)
int	getModifier()
int	or(int modifier)
int	or(PropOption option)
static PropOption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PropOption[]	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

Abstract

public static final PropOption Abstract

For use with get, set to override the non-use of abstract modifier on a @var property, or individually with get and set. If specified, the generated get/set method will be abstract. Note only properties declared in interfaces and abstract classes can be abstract. If the corresponding get/set method is user-defined, it must be declared abstract.

    // only the setter method is abstract
   @var @set(Abstract) String name;
 

Final

public static final PropOption Final

For use with get, set to override the non-use of final modifier on a @var property, or individually with get and set. If specified, the generated get/set method will be final. Note properties declared in interfaces cannot be final. If the corresponding get/set method is user-defined, it must be declared final.

    // only the setter is final
   @var @set(Final) String name;
 

Private

public static final PropOption Private

For use with get, set to override the property's declared accessibility. If specified, the generated get and/or set methods will be private. If the corresponding get/set method is user-defined, it must be declared private.

Package

public static final PropOption Package

For use with {@link var}, get, set to override the property's declared accessibility. If specified, the generated get and/or set methods will be package-private. If the corresponding get/set method is user-defined, it must be declared package-private.

Protected

public static final PropOption Protected

For use with get, set to override the property's declared accessibility. If specified, the generated get and/or set methods will be protected. If the corresponding get/set method is user-defined, it must be declared protected.

Public

public static final PropOption Public

For use with get, set to override the property's declared accessibility. If specified, the generated get and/or set methods will be public. If the corresponding get/set method is user-defined, it must be declared public.

Method Detail

values

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

Returns:

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

valueOf

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

getModifier

public int getModifier()

Returns:

The Java Modifier integral value corresponding with the option.

or

public int or(PropOption option)

or

public int or(int modifier)

fromModifier

public static PropOption fromModifier(int modifier)