com.yworks.yfiles.bpmn.view
Class EventCharEnum

java.lang.Object
  com.yworks.yfiles.bpmn.view.EventCharEnum

public class EventCharEnum

extends Object

Type-safe enumeration for BPMN event characteristics.

Field Summary

static EventCharEnum	EVENT_CHARACTERISTIC_END Characteristic constant for an end event.
static EventCharEnum	EVENT_CHARACTERISTIC_INTERMEDIATE_BOUNDARY_INTERRUPTING Characteristic constant for an intermediate (boundary interrupting) events.
static EventCharEnum	EVENT_CHARACTERISTIC_INTERMEDIATE_BOUNDARY_NON_INTERRUPTING Characteristic constant for an intermediate (boundary non-interrupting) event.
static EventCharEnum	EVENT_CHARACTERISTIC_INTERMEDIATE_CATCHING Characteristic constant for an intermediate (catching) event.
static EventCharEnum	EVENT_CHARACTERISTIC_INTERMEDIATE_THROWING Characteristic constant for an intermediate (throwing) event.
static EventCharEnum	EVENT_CHARACTERISTIC_START Characteristic constant for a start (top level) event.
static EventCharEnum	EVENT_CHARACTERISTIC_START_EVENT_SUB_PROCESS_INTERRUPTING Characteristic constant for a start (event sub-process interrupting) event.
static EventCharEnum	EVENT_CHARACTERISTIC_START_EVENT_SUB_PROCESS_NON_INTERRUPTING Characteristic constant for a start (event sub-process non-interrupting) event.

Method Summary

static EventCharEnum	getByName(String name) Retrieves the event characteristic constant that corresponds to the specified characteristic name.
static List	getEventCharacteristics() Returns an unmodifiable list of all BPMN event characteristics.
static List	getSupportedEventCharacteristics(BpmnTypeEnum type) Returns an unmodifiable list of all BPMN event characteristics that are supported by the specified BPMN event type.
static boolean	isIntermediateEvent(EventCharEnum characteristic) Determines whether or not the specified characteristic denotes an intermediate event.
static boolean	isStartEvent(EventCharEnum characteristic) Determines whether or not the specified characteristic denotes a start event.
static boolean	isSupportedEventCharacteristic(BpmnTypeEnum type, EventCharEnum characteristic) Returns whether or not the specified BPMN type supports the specified BPMN event characteristic.
String	toString() Returns a string representation of this event characteristic.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EVENT_CHARACTERISTIC_START

public static final EventCharEnum EVENT_CHARACTERISTIC_START

Characteristic constant for a start (top level) event.

EVENT_CHARACTERISTIC_START_EVENT_SUB_PROCESS_INTERRUPTING

public static final EventCharEnum EVENT_CHARACTERISTIC_START_EVENT_SUB_PROCESS_INTERRUPTING

Characteristic constant for a start (event sub-process interrupting) event.

EVENT_CHARACTERISTIC_START_EVENT_SUB_PROCESS_NON_INTERRUPTING

public static final EventCharEnum EVENT_CHARACTERISTIC_START_EVENT_SUB_PROCESS_NON_INTERRUPTING

Characteristic constant for a start (event sub-process non-interrupting) event.

EVENT_CHARACTERISTIC_INTERMEDIATE_CATCHING

public static final EventCharEnum EVENT_CHARACTERISTIC_INTERMEDIATE_CATCHING

Characteristic constant for an intermediate (catching) event.

EVENT_CHARACTERISTIC_INTERMEDIATE_BOUNDARY_INTERRUPTING

public static final EventCharEnum EVENT_CHARACTERISTIC_INTERMEDIATE_BOUNDARY_INTERRUPTING

Characteristic constant for an intermediate (boundary interrupting) events.

EVENT_CHARACTERISTIC_INTERMEDIATE_BOUNDARY_NON_INTERRUPTING

public static final EventCharEnum EVENT_CHARACTERISTIC_INTERMEDIATE_BOUNDARY_NON_INTERRUPTING

Characteristic constant for an intermediate (boundary non-interrupting) event.

EVENT_CHARACTERISTIC_INTERMEDIATE_THROWING

public static final EventCharEnum EVENT_CHARACTERISTIC_INTERMEDIATE_THROWING

Characteristic constant for an intermediate (throwing) event.

EVENT_CHARACTERISTIC_END

public static final EventCharEnum EVENT_CHARACTERISTIC_END

Characteristic constant for an end event.

Method Detail

toString

public String toString()

Returns a string representation of this event characteristic.

Returns:

a string representation of this event characteristic.

getByName

public static EventCharEnum getByName(String name)

Retrieves the event characteristic constant that corresponds to the specified characteristic name.

Parameters:

name - the name of the BPMN event characteristic. Should be one of

• EVENT_CHARACTERISTIC_START
• EVENT_CHARACTERISTIC_START_EVENT_SUB_PROCESS_INTERRUPTING
• EVENT_CHARACTERISTIC_START_EVENT_SUB_PROCESS_NON_INTERRUPTING
• EVENT_CHARACTERISTIC_INTERMEDIATE_CATCHING
• EVENT_CHARACTERISTIC_INTERMEDIATE_BOUNDARY_INTERRUPTING
• EVENT_CHARACTERISTIC_INTERMEDIATE_BOUNDARY_NON_INTERRUPTING
• EVENT_CHARACTERISTIC_INTERMEDIATE_THROWING
• EVENT_CHARACTERISTIC_END

Returns:

the event characteristic constant for the given name or null if there is no corresponding characteristic constant.

getEventCharacteristics

public static List getEventCharacteristics()

Returns an unmodifiable list of all BPMN event characteristics.

Returns:

a list of EventCharEnum instances.

getSupportedEventCharacteristics

public static List getSupportedEventCharacteristics(BpmnTypeEnum type)

Returns an unmodifiable list of all BPMN event characteristics that are supported by the specified BPMN event type.

Parameters:

type - the BPMN event type to check.

Returns:

a list of EventCharEnum instances representing the BPMN event characteristics supported by the specified BPMN event type.

isSupportedEventCharacteristic

public static boolean isSupportedEventCharacteristic(BpmnTypeEnum type,
                                                     EventCharEnum characteristic)

Returns whether or not the specified BPMN type supports the specified BPMN event characteristic.

Parameters:

type - the BPMN event type to check.

characteristic - the BPMN event characteristic to check.

Returns:

true if the specified BPMN type supports the specified BPMN event characteristic; false otherwise.

isStartEvent

public static boolean isStartEvent(EventCharEnum characteristic)

Determines whether or not the specified characteristic denotes a start event.

Parameters:

characteristic - the event characteristic to check.

Returns:

true if the specified characteristic denotes a start event and false otherwise.

isIntermediateEvent

public static boolean isIntermediateEvent(EventCharEnum characteristic)

Determines whether or not the specified characteristic denotes an intermediate event.

Parameters:

characteristic - the event characteristic to check.

Returns:

true if the specified characteristic denotes an intermediate event and false otherwise.