org.iqual.chaplin.msg
Enum MessageScope

java.lang.Object
  java.lang.Enum<MessageScope>
      org.iqual.chaplin.msg.MessageScope

All Implemented Interfaces:

Serializable, Comparable<MessageScope>

public enum MessageScope
extends Enum<MessageScope>

Since:

Jun 15, 2009 10:14:48 PM

Author:

Zbynek Slajchrt

Enum Constant Summary

global
The message is processed from the top composite downwards.

local
The message is processed from the nearest composite only downwards.

universal
The message is processed from the top composite downwards and, if needed, in the context stack.

Method Summary

static MessageScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static MessageScope[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

local

public static final MessageScope local

The message is processed from the nearest composite only downwards.

global

public static final MessageScope global

The message is processed from the top composite downwards.

universal

public static final MessageScope universal

The message is processed from the top composite downwards and, if needed, in the context stack. The context stack is engaged if the message has not yet been processed as many times as the message's minOccurs property indicates.

Method Detail

values

public static final MessageScope[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(MessageScope c : MessageScope.values())
        System.out.println(c);

Returns:

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

valueOf

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