org.jruby.embed

Enum LocalVariableBehavior

java.lang.Object

java.lang.Enum<LocalVariableBehavior>

org.jruby.embed.LocalVariableBehavior

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LocalVariableBehavior>

public enum LocalVariableBehavior
extends java.lang.Enum<LocalVariableBehavior>

Enum Constant Summary

Enum Constants

Enum Constant and Description
BSF Specifies that a sharing variable works for BSF JRuby Engine.
GLOBAL Specifies that a sharing variable works like JSR 223 reference implementation.
PERSISTENT Specifies that Ruby's local variables survive over multiple evaluations.
TRANSIENT Specifies that Ruby's local variables have faithful behavior to its semantics.

Method Summary

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

GLOBAL

public static final LocalVariableBehavior GLOBAL

Specifies that a sharing variable works like JSR 223 reference implementation. Variable names in Java are mapped to global variables in Ruby.

PERSISTENT

public static final LocalVariableBehavior PERSISTENT

Specifies that Ruby's local variables survive over multiple evaluations.

TRANSIENT

public static final LocalVariableBehavior TRANSIENT

Specifies that Ruby's local variables have faithful behavior to its semantics. Local variables do not survive over an evaluation. All local variables will vanish after every evaluation.

BSF

public static final LocalVariableBehavior BSF

Specifies that a sharing variable works for BSF JRuby Engine. Variable names in Java are mapped to global variables in Ruby when it is shared through org.apache.bsf.BSFDeclaredBean.

Method Detail

values

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

Returns:

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

valueOf

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