Top Description Fields Constructors Methods
org.jruby.embed

public final Enum AttributeName

extends Enum<AttributeName>
Class Inheritance
Predefined keys for an attribute map that ScriptingContainer has. Usage example: 
    ScriptingContainer container = new ScriptingContainer();
    container.setAttribute(AttributeName.BASE_DIR, System.getProperty("user.dir");
Author
Yoko Harada <[email protected]>

Field Summary

Modifier and TypeField and Description
public static final AttributeName
BASE_DIR

A key used in an attribute map to set a base directory.

public static final AttributeName
CLEAR_VARAIBLES

A key used in an attribute map to turn on/off clearing variables.

public static final AttributeName
ERROR_WRITER

A key used in an attribute map to set an error writer.

private final String
fqpn

public static final AttributeName
LINENUMBER

A key used in an attribute map to set a line number in error message.

public static final AttributeName
READER

A key used in an attribute map to set a reader.

public static final AttributeName
RECEIVER

A key used in an attribute map to set a receiver object for sharing variables.

public static final AttributeName
SHARING_VARIABLES

A key used in an attribute map to turn on/off sharing variable feature.

public static final AttributeName
TERMINATION

A key used in an attribute map to turn on/off termination.

public static final AttributeName
UNICODE_ESCAPE

A key used in an attribute map to specify that the script to be parsed has unicode escape in it.

public static final AttributeName
WRITER

A key used in an attribute map to set a writer.

Constructor Summary

AccessConstructor and Description
private
AttributeName(String fqpn)

Creates an AttributeName Enum type instance.

Method Summary

Modifier and TypeMethod and Description
public static AttributeName

Returns:

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

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

public String

Returns:

a fully qualified attribute name
toString()

Overrides java.lang.Enum.toString.

Returns the fully qualified attribute name of this enum constant.

public static AttributeName
valueOf(String name)

public static AttributeName[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

BASE_DIRback to summary
public static final AttributeName BASE_DIR

A key used in an attribute map to set a base directory. This attribute can be set using a System property, org.jruby.embed.basedir.

CLEAR_VARAIBLESback to summary
public static final AttributeName CLEAR_VARAIBLES

A key used in an attribute map to turn on/off clearing variables. This attribute is for JSR223 only. Default is false, which means JRubyEngine doesn't clear an internal variable table, which ends up in being reused. If true is set, JRubyEngine clears the internal variable table.

ERROR_WRITERback to summary
public static final AttributeName ERROR_WRITER

A key used in an attribute map to set an error writer. This attribute can be set using a System property, org.jruby.embed.errorwriter.

fqpnback to summary
private final String fqpn
LINENUMBERback to summary
public static final AttributeName LINENUMBER

A key used in an attribute map to set a line number in error message. This attribute is for JSR223 only. This attribute can be set using a System property, org.jruby.embed.linenumber.

READERback to summary
public static final AttributeName READER

A key used in an attribute map to set a reader. This attribute can be set using a System property, org.jruby.embed.reader.

RECEIVERback to summary
public static final AttributeName RECEIVER

A key used in an attribute map to set a receiver object for sharing variables. This attribute is for JSR223 only. This attribute can be set using a System property, org.jruby.embed.receiver.

SHARING_VARIABLESback to summary
public static final AttributeName SHARING_VARIABLES

A key used in an attribute map to turn on/off sharing variable feature. Default is true. If false is set, sharing variables goes off, and better performance will be expected. This attribute can be set using a System property, org.jruby.embed.sharing.variables.

TERMINATIONback to summary
public static final AttributeName TERMINATION

A key used in an attribute map to turn on/off termination. This attribute is for JSR223 only. Default is false, which means JRubyEngine doesn't terminate any state and doesn't execute at_exit blocks. If true is set, JRubyEngine terminates the state as well as executes at_exit blocks. This attribute can be set using a System property, org.jruby.embed.termination.

UNICODE_ESCAPEback to summary
public static final AttributeName UNICODE_ESCAPE

A key used in an attribute map to specify that the script to be parsed has unicode escape in it. Default is false. This attribute can be set using a System property, org.jruby.embed.unicode.escpe.

WRITERback to summary
public static final AttributeName WRITER

A key used in an attribute map to set a writer. This attribute can be set using a System property, org.jruby.embed.writer.

Constructor Detail

AttributeNameback to summary
private AttributeName(String fqpn)

Creates an AttributeName Enum type instance.

Method Detail

getTypeback to summary
public static AttributeName getType(String fqpn)

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

Parameters
fqpn:String

fully qualified attribute name

Returns:AttributeName

a matched enumerated type identifier

toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Returns the fully qualified attribute name of this enum constant.

Returns:String

a fully qualified attribute name

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