net.sf.eBus.client

Enum EFeed.FeedScope

java.lang.Object

java.lang.Enum<EFeed.FeedScope>

net.sf.eBus.client.EFeed.FeedScope

All Implemented Interfaces:

Serializable, Comparable<EFeed.FeedScope>

Enclosing class:

EFeed

public static enum EFeed.FeedScope
extends Enum<EFeed.FeedScope>

Feed scope is either restricted to this JVM, to both this JVM and remote JVMs, and to remote JVMs only. The feed scope is used to determine if two opposing feeds (publish and subscibe or reply and ERequestFeed) match and so may exchange messages.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOCAL_AND_REMOTE This feed is matched by both local and remote feeds.
LOCAL_ONLY This feed is matched only by other feeds within this JVM.
REMOTE_ONLY This feed is matched only by feeds on remote JVMs.

Method Summary

Modifier and Type	Method and Description
boolean	supports(EClient.ClientLocation loc) Returns true if this scope supports the given client location; false otherwise.
String	toString()
static EFeed.FeedScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static EFeed.FeedScope[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOCAL_ONLY

public static final EFeed.FeedScope LOCAL_ONLY

This feed is matched only by other feeds within this JVM.

LOCAL_AND_REMOTE

public static final EFeed.FeedScope LOCAL_AND_REMOTE

This feed is matched by both local and remote feeds.

REMOTE_ONLY

public static final EFeed.FeedScope REMOTE_ONLY

This feed is matched only by feeds on remote JVMs.

Method Detail

values

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

Returns:

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

valueOf

public static EFeed.FeedScope 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

NullPointerException - if the argument is null

supports

public boolean supports(EClient.ClientLocation loc)

Returns true if this scope supports the given client location; false otherwise.

Parameters:

loc - check this client location.

Returns:

true if client location is supported.

toString

public String toString()

Overrides:

toString in class Enum<EFeed.FeedScope>