Module org.jruby.base

Package org.jruby.embed

Enum Class LocalVariableBehavior

java.lang.Object

java.lang.Enum<LocalVariableBehavior>

org.jruby.embed.LocalVariableBehavior

All Implemented Interfaces:

Serializable, Comparable<LocalVariableBehavior>, Constable

public enum LocalVariableBehavior
extends Enum<LocalVariableBehavior>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	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	Description
static LocalVariableBehavior	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LocalVariableBehavior[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static LocalVariableBehavior[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LocalVariableBehavior valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null