Package org.jruby.embed

Enum PathType

java.lang.Object

java.lang.Enum<PathType>

org.jruby.embed.PathType

All Implemented Interfaces:

Serializable, Comparable<PathType>, java.lang.constant.Constable

public enum PathType
extends Enum<PathType>

The path type that tells from where Ruby runtime should load the specified file.

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
ABSOLUTE	Given filename is an absolute path.
CLASSPATH	Given filename should be found from a classpath.
RELATIVE	Given filename is a relative path to a base directory.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PathType()

Method Summary

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

ABSOLUTE

public static final PathType ABSOLUTE

Given filename is an absolute path.

RELATIVE

public static final PathType RELATIVE

Given filename is a relative path to a base directory. To set the base directory, use setAttribute() method of ScriptingContainer.

     ScriptingContainer container = new ScriptingContainer();
     container.setAttribute(AttributeName.BASE_DIR, System.getProperty("user.dir"));
     String filename =  "test/ruby/iteration.rb";
     Object receiver = container.runScriptlet(PathType.RELATIVE, filename);

CLASSPATH

public static final PathType CLASSPATH

Given filename should be found from a classpath.

Constructor Details

PathType

private PathType()

Method Details

values

public static PathType[] values()

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

Returns:

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

valueOf

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