PathType.java

/**
 * **** BEGIN LICENSE BLOCK *****
 * Version: EPL 1.0/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Eclipse Public
 * License Version 1.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of
 * the License at http://www.eclipse.org/legal/epl-v10.html
 *
 * Software distributed under the License is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * rights and limitations under the License.
 *
 * Copyright (C) 2009 Yoko Harada <yokolet@gmail.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the EPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the EPL, the GPL or the LGPL.
 * **** END LICENSE BLOCK *****
 */
package org.jruby.embed;

/**
 * The path type that tells from where Ruby runtime should load the specified file.
 * 
 * @author Yoko Harada <yokolet@gmail.com>
 */
public enum PathType {
    /**
     * Given filename is an absolute path.
     */
    ABSOLUTE,

    /**
     * Given filename is a relative path to a base directory.
     *
     * To set the base directory, use setAttribute() method of {@link ScriptingContainer}.
     *
     * <pre>
     *     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);</pre>
     */
    RELATIVE,

    /**
     * Given filename should be found from a classpath.
     */
    CLASSPATH
}