javax.servlet.sip.ar
Enum SipRouteModifier

java.lang.Object
  java.lang.Enum<SipRouteModifier>
      javax.servlet.sip.ar.SipRouteModifier

All Implemented Interfaces:

Serializable, Comparable<SipRouteModifier>

public enum SipRouteModifier
extends Enum<SipRouteModifier>

Route modifiers as returned by the Application Router, used to interpret the returned route from the router.

Since:

1.1

Enum Constant Summary

NO_ROUTE
Indicates that SipApplicationRouterInfo.getRoute() does not contain any valid route.

ROUTE
Indicates that the route returned by SipApplicationRouterInfo.getRoute() is a valid route.

ROUTE_BACK
Tells the container to push a route back to itself before pusing the external routes specified by SipApplicationRouterInfo.getRoutes().

Method Summary

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

ROUTE_BACK

public static final SipRouteModifier ROUTE_BACK

Tells the container to push a route back to itself before pusing the external routes specified by SipApplicationRouterInfo.getRoutes().

NO_ROUTE

public static final SipRouteModifier NO_ROUTE

Indicates that SipApplicationRouterInfo.getRoute() does not contain any valid route.

ROUTE

public static final SipRouteModifier ROUTE

Indicates that the route returned by SipApplicationRouterInfo.getRoute() is a valid route.

Method Detail

values

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

Returns:

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

valueOf

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