Top Description Fields Constructors Methods
org.jruby.embed

public final Enum PropertyName

extends Enum<PropertyName>
Class Inheritance

Predefined keys of System properties to get configurations
Author
Yoko Harada <[email protected]>

Field Summary

Modifier and TypeField and Description
public static final PropertyName
CLASSLOADER

A key to get/set the value for classloader policy.

public static final PropertyName
CLASSPATH

A key used to get/set classpath setting.

public static final PropertyName
COMPATVERSION

A key to get/set compatible version to Ruby.

public static final PropertyName
COMPILEMODE

A key to get/set compile mode.

private final String
public static final PropertyName
LAZINESS

A key to get/set variables/constants retrieval policy.

public static final PropertyName
LOCALCONTEXT_SCOPE

A key to get/set local context scope.

public static final PropertyName
LOCALVARIABLE_BEHAVIOR

A key to get/set local variable behavior.

Constructor Summary

AccessConstructor and Description
private
PropertyName(String
a fully qualified property name
fqpn
)

Creates an PropertyName Enum type instance.

Method Summary

Modifier and TypeMethod and Description
public static PropertyName

Returns:

a matched enumerated type identifier
getType
(String
fully qualified property name
fqpn
)

Returns a fully qualified property name that corresponds to a given enumerated type identifier.

public String

Returns:

a fully qualified property name
toString
()

Overrides java.lang.Enum.toString.

Returns the fully qualified property name of this enum constant.

public static PropertyName
public static PropertyName[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

CLASSLOADERback to summary
public static final PropertyName CLASSLOADER

A key to get/set the value for classloader policy. The key is equivalent to a System property, org.jruby.embed.classloader. The assigned value must be "current" or "none." When current is set, JSR223 engine sets a current classloader (the one used to initialize ScriptingContainer) to Ruby runtime. When none is set, no classloader is set to Ruby runtime. Default value is "none" for version 1.5.x, and "current" for 1.6.0 and later. This property is used only for JSR223 since ScriptingContainer users can set any classloader explicitely.

CLASSPATHback to summary
public static final PropertyName CLASSPATH

A key used to get/set classpath setting. The key is equivalent to a System property, org.jruby.embed.class.path.

COMPATVERSIONback to summary
public static final PropertyName COMPATVERSION

A key to get/set compatible version to Ruby. The key is equivalent to a System property, org.jruby.embed.compat.version. If the assigned value matches j?ruby1[\\._]?9, then Ruby 1.9 mode will be used to evaluate a given code.

COMPILEMODEback to summary
public static final PropertyName COMPILEMODE

A key to get/set compile mode. The key is equivalent to a System property, org.jruby.embed.compilemode. The assigned value must be jit or force.

fqpnback to summary
private final String fqpn
LAZINESSback to summary
public static final PropertyName LAZINESS

A key to get/set variables/constants retrieval policy. The key is equivalent to a System property, org.jruby.embed.laziness. The assigned value must be true or false. When true is given, ScriptingContainer retrieve variables/constants from Ruby runtime lazily. When a variable or constant is requested from user program, ScriptingContainer actually attemps to get it. However, on JSR223, retrieval is done at the end of evaluation based on keys listed in Bindings.

LOCALCONTEXT_SCOPEback to summary
public static final PropertyName LOCALCONTEXT_SCOPE

A key to get/set local context scope. The key is equivalent to a System property, org.jruby.embed.localcontext.scope. The assigned value must be one of threadsafe, singlethread, or singleton.

LOCALVARIABLE_BEHAVIORback to summary
public static final PropertyName LOCALVARIABLE_BEHAVIOR

A key to get/set local variable behavior. The key is equivalent to a System property, org.jruby.embed.localvariable.behavior. The assigned value must be one of transient, persistent, or global for Embed Core and JSR223. BSF can choose bsf only.

Constructor Detail

PropertyNameback to summary
private PropertyName(String fqpn)

Creates an PropertyName Enum type instance.

Parameters
fqpn:String

a fully qualified property name

Method Detail

getTypeback to summary
public static PropertyName getType(String fqpn)

Returns a fully qualified property name that corresponds to a given enumerated type identifier.

Parameters
fqpn:String

fully qualified property name

Returns:PropertyName

a matched enumerated type identifier

toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Returns the fully qualified property name of this enum constant.

Returns:String

a fully qualified property name

Annotations
@Override
valueOfback to summary
public static PropertyName valueOf(String name)
valuesback to summary
public static PropertyName[] values()