Package com.bea.httppubsub

Enum Channel.ChannelPattern

java.lang.Object

java.lang.Enum<Channel.ChannelPattern>

com.bea.httppubsub.Channel.ChannelPattern

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Channel.ChannelPattern>

Enclosing interface:

Channel

public static enum Channel.ChannelPattern
extends java.lang.Enum<Channel.ChannelPattern>

This enum provides constants of the three channel patterns that are described in section 2.2.1 Channel Globbing of the Bayeux Protocol. .

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL_SUBCHANNELS
IMMEDIATE_SUBCHANNELS
ITSELF

Method Summary

Modifier and Type	Method	Description
static Channel.ChannelPattern	getPattern(java.lang.String url)	Get the ChannelPattern from the given url
static Channel.ChannelPattern	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Channel.ChannelPattern[]	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

ITSELF

public static final Channel.ChannelPattern ITSELF

IMMEDIATE_SUBCHANNELS

public static final Channel.ChannelPattern IMMEDIATE_SUBCHANNELS

ALL_SUBCHANNELS

public static final Channel.ChannelPattern ALL_SUBCHANNELS

Method Detail

values

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

Returns:

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

valueOf

public static Channel.ChannelPattern 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

getPattern

public static Channel.ChannelPattern getPattern(java.lang.String url)

Get the ChannelPattern from the given url

Parameters:

url - the url of channel, such as "/foo/bar/**" or "/foo" and so on

Returns:

ChannelPattern corresponding to the given channel

Throws:

java.lang.NullPointerException - if url is null