org.electrocodeogram.cpc.core.api.hub.event
Enum CloneNotificationEvent.Type

java.lang.Object
  java.lang.Enum<CloneNotificationEvent.Type>
      org.electrocodeogram.cpc.core.api.hub.event.CloneNotificationEvent.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CloneNotificationEvent.Type>

Enclosing class:

CloneNotificationEvent

public static enum CloneNotificationEvent.Type
extends java.lang.Enum<CloneNotificationEvent.Type>

Possible presentation styles for this notification event.
Closely related to IEvaluationResult.Action.

See Also:

IEvaluationResult

Enum Constant Summary

DELAY_NOTIFY
Similar to NOTIFY.

DELAY_WARN
Similar to WARN.

NOTIFY

WARN

Method Summary

static CloneNotificationEvent.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CloneNotificationEvent.Type[]	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

NOTIFY

public static final CloneNotificationEvent.Type NOTIFY

See Also:

IEvaluationResult.Action#NOTIFY

WARN

public static final CloneNotificationEvent.Type WARN

See Also:

IEvaluationResult.Action#WARN

DELAY_NOTIFY

public static final CloneNotificationEvent.Type DELAY_NOTIFY

Similar to NOTIFY.
However, this type indicates that the user should not be notified instantly but that the notification should be queued and that the modification should be reevaluated once the clone modification has finished.
There are multiple potential approaches to this problem.
I.e. notifications could be delayed until the user closes the corresponding editor or until the clone or the file it is located in has not been modified for a specific amount of time.

DELAY_WARN

public static final CloneNotificationEvent.Type DELAY_WARN

Similar to WARN.

See Also:

DELAY_NOTIFY

Method Detail

values

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

Returns:

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

valueOf

public static CloneNotificationEvent.Type valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null