org.mases.jcobridge

Class JCEnum

java.lang.Object

org.mases.jcobridge.JCEnum

public final class JCEnum
extends Object

JVM-side representation of a CLR enum value, including support for [Flags] enums.

A JCEnum carries the fully qualified CLR enum type name, one or more selected values (for [Flags] enums), and the complete set of valid values for the type. Instances are obtained via JCOBridge.GetEnum(String) and must not be constructed directly.

For plain (non-Flags) enums, a JCEnum holds a single value and fromValue(java.lang.String) is the primary factory. For [Flags] enums, multiple values can be combined using add(JCEnum) (logical OR) and removed with remove(JCEnum) (logical XOR). Membership tests are available via is(JCEnum) (exact match) and has(JCEnum) (subset check).

All operations that combine two JCEnum instances enforce type safety: mixing values from different CLR enum types throws JCException.

See also: JCOReflector for usage examples.

Since:

1.0.0.0

Author:

MASES S.R.L.

Method Summary

Modifier and Type	Method and Description
JCEnum	add(JCEnum value) Returns a new JCEnum that is the logical OR (union) of this instance and value.
JCEnum	fromValue(String val) Returns a new JCEnum instance selecting the given single value.
JCEnum	fromValues(String... values) Returns a new JCEnum instance selecting the given values.
String[]	getAllValues() Returns all valid value names for this CLR enum type.
String	getTypeName() Returns the fully qualified CLR enum type name.
String	getValue() Returns the currently selected value(s) as a comma-separated string.
String[]	getValues() Returns the currently selected value names as an array.
boolean	has(JCEnum value) Returns true if this instance contains at least one of the values in value (subset / flag-present check).
boolean	is(JCEnum value) Returns true if this instance selects exactly the same set of values as value (exact equality, not subset).
JCEnum	remove(JCEnum value) Returns a new JCEnum that is the logical XOR (difference) of this instance and value, removing the flags present in value from this instance.
String	toString() Returns a human-readable string in the form "TypeName: value1, value2, ...".

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

fromValue

public JCEnum fromValue(String val)
                 throws JCException

Returns a new JCEnum instance selecting the given single value. Equivalent to fromValues(String...) with a single argument.

Parameters:

val - the string name of the enum value to select.

Returns:

a new JCEnum with the selected value.

Throws:

JCException - if val is not a valid value for this enum type.

fromValues

public JCEnum fromValues(String... values)
                  throws JCException

Returns a new JCEnum instance selecting the given values. Use this method for [Flags] enums to combine multiple named flags.

Parameters:

values - the string names of the enum values to select.

Returns:

a new JCEnum with the selected values.

Throws:

JCException - if any of the given values is not a member of this enum type.

toString

public String toString()

Returns a human-readable string in the form "TypeName: value1, value2, ...".

Overrides:

toString in class Object

Returns:

the string representation of this enum instance.

getTypeName

public String getTypeName()

Returns the fully qualified CLR enum type name.

Returns:

the CLR enum type name, e.g. "System.IO.FileMode".

getValue

public String getValue()

Returns the currently selected value(s) as a comma-separated string. For single-value enums this is the value name; for [Flags] enums it is the comma-separated list of active flag names.

Returns:

the selected value(s) as a string.

getValues

public String[] getValues()

Returns the currently selected value names as an array. For single-value enums the array has one element; for [Flags] enums it contains all active flag names.

Returns:

the selected value name(s).

getAllValues

public String[] getAllValues()

Returns all valid value names for this CLR enum type.

Returns:

all valid enum value names.

add

public JCEnum add(JCEnum value)
           throws JCException

Returns a new JCEnum that is the logical OR (union) of this instance and value. Intended for [Flags] enums. Duplicate values are deduplicated in the result.

Parameters:

value - the flags to add.

Returns:

a new JCEnum containing all flags from both operands.

Throws:

JCException - if value belongs to a different CLR enum type.

remove

public JCEnum remove(JCEnum value)
              throws JCException

Returns a new JCEnum that is the logical XOR (difference) of this instance and value, removing the flags present in value from this instance. Intended for [Flags] enums.

Parameters:

value - the flags to remove.

Returns:

a new JCEnum with the specified flags removed.

Throws:

JCException - if value belongs to a different CLR enum type.

is

public boolean is(JCEnum value)
           throws JCException

Returns true if this instance selects exactly the same set of values as value (exact equality, not subset).

Parameters:

value - the enum instance to compare with.

Returns:

true if both instances select the same values.

Throws:

JCException - if value belongs to a different CLR enum type.

has

public boolean has(JCEnum value)
            throws JCException

Returns true if this instance contains at least one of the values in value (subset / flag-present check). Intended for [Flags] enums.

Parameters:

value - the flags to test for presence.

Returns:

true if any flag in value is set in this instance.

Throws:

JCException - if value belongs to a different CLR enum type.