org.jruby.embed
Enum PathType

java.lang.Object
  java.lang.Enum<PathType>
      org.jruby.embed.PathType

All Implemented Interfaces:

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

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

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

Author:

Yoko Harada

Enum Constant Summary

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.

Method Summary

static PathType	valueOf(java.lang.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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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.

Method Detail

values

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

Returns:

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

valueOf

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