org.mases.jcobridge

Class JCEnum

java.lang.Object

org.mases.jcobridge.JCEnum

public final class JCEnum
extends Object

The JCEnum class represents a reflected CLR Enum.

To instantiate a valid JCEnum use a valid instance of JCOBridge with JCOBridge.GetEnum(java.lang.String).

Some examples on its use are on https://github.com/masesgroup/JCOReflector

Since:

1.0.0.0

Author:

MASES S.R.L.

Method Summary

Modifier and Type	Method and Description
JCEnum	add(JCEnum value) Execute the OR operation in case of Flags
JCEnum	fromValue(String val) Returns a new JCEnum from the input parameter.
JCEnum	fromValues(String... values) Returns a new JCEnum from the input parameter.
String[]	getAllValues()
String	getTypeName()
String	getValue()
String[]	getValues()
boolean	has(JCEnum value) Check if this JCEnum contains the input JCEnum
boolean	is(JCEnum value) Check if this JCEnum is the input JCEnum
JCEnum	remove(JCEnum value) Execute the XOR operation in case of Flags
String	toString() This method is used to get an equivalent CLR ToString.

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 from the input parameter.

Parameters:

val - The string representation of CLR Enum value to use

Returns:

The new JCEnum instance

Throws:

JCException - in case the JCEnum does not contains input value

fromValues

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

Returns a new JCEnum from the input parameter. Use in case of CLR Flags

Parameters:

values - The string representations of CLR Enum values to use

Returns:

The new JCEnum instance

Throws:

JCException - in case the JCEnum does not contains input values

toString

public String toString()

This method is used to get an equivalent CLR ToString.

Overrides:

toString in class Object

Returns:

the string representation of this JCEnum

getTypeName

public String getTypeName()

Returns:

The CLR String representation of the Enum Type

getValue

public String getValue()

Returns:

The CLR String representation of the Enum value

getValues

public String[] getValues()

Returns:

The CLR String representation of the Enum values. In case of Flags.

getAllValues

public String[] getAllValues()

Returns:

The CLR String representation of all values of the Enum

add

public JCEnum add(JCEnum value)
           throws JCException

Execute the OR operation in case of Flags

Parameters:

value - The value to use to make the OR operation

Returns:

The new JCEnum

Throws:

JCException - in case the input JCEnum is not compliant in type

remove

public JCEnum remove(JCEnum value)
              throws JCException

Execute the XOR operation in case of Flags

Parameters:

value - The value to use to make the OR operation

Returns:

The new JCEnum

Throws:

JCException - in case the input JCEnum is not compliant in type

is

public boolean is(JCEnum value)
           throws JCException

Check if this JCEnum is the input JCEnum

Parameters:

value - The value to use to make the operation

Returns:

True if this JCEnum is the input

Throws:

JCException - in case the input JCEnum is not compliant in type

has

public boolean has(JCEnum value)
            throws JCException

Check if this JCEnum contains the input JCEnum

Parameters:

value - The value to use to make the operation

Returns:

True if this JCEnum has the input

Throws:

JCException - in case the input JCEnum is not compliant in type