org.jruby.embed

Interface EmbedRubyRuntimeAdapter

All Superinterfaces:

RubyRuntimeAdapter

All Known Implementing Classes:

EmbedRubyRuntimeAdapterImpl

public interface EmbedRubyRuntimeAdapter
extends RubyRuntimeAdapter

Wrapper interface of RubyRuntimeAdapter for embedding. This interface defines Java friendly parse methods.

Method Summary

Modifier and Type	Method and Description
EmbedEvalUnit	parse(java.io.InputStream istream, java.lang.String filename, int... lines) Parses a script given by a input stream and return an object which can be run().
EmbedEvalUnit	parse(PathType type, java.lang.String filename, int... lines) Parses a script read from a specified path and return an object which can be run().
EmbedEvalUnit	parse(java.io.Reader reader, java.lang.String filename, int... lines) Parses a script given by a reader and return an object which can be run().
EmbedEvalUnit	parse(java.lang.String script, int... lines) Parses a script and return an object which can be run().

Methods inherited from interface org.jruby.RubyRuntimeAdapter

eval, parse, parse

Method Detail

parse

EmbedEvalUnit parse(java.lang.String script,
                    int... lines)

Parses a script and return an object which can be run(). This allows the script to be parsed once and evaluated many times.

Parameters:

script - is a Ruby script to be parsed

lines - are linenumbers to display for parse errors and backtraces. This field is optional. Only the first argument is used for parsing. When no line number is specified, 0 is applied to.

Returns:

an object which can be run

parse

EmbedEvalUnit parse(java.io.Reader reader,
                    java.lang.String filename,
                    int... lines)

Parses a script given by a reader and return an object which can be run(). This allows the script to be parsed once and evaluated many times.

Parameters:

reader - is used to read a script from

filename - is used as in information, for example, appears in a stack trace of an exception

lines - are linenumbers to display for parse errors and backtraces. This field is optional. Only the first argument is used for parsing. When no line number is specified, 0 is applied to.

Returns:

an object which can be run

parse

EmbedEvalUnit parse(PathType type,
                    java.lang.String filename,
                    int... lines)

Parses a script read from a specified path and return an object which can be run(). This allows the script to be parsed once and evaluated many times.

Parameters:

type - is one of the types PathType defines

filename - is used as in information, for example, appears in a stack trace of an exception

lines - are linenumbers to display for parse errors and backtraces. This field is optional. Only the first argument is used for parsing. When no line number is specified, 0 is applied to.

Returns:

an object which can be run

parse

EmbedEvalUnit parse(java.io.InputStream istream,
                    java.lang.String filename,
                    int... lines)

Parses a script given by a input stream and return an object which can be run(). This allows the script to be parsed once and evaluated many times.

Parameters:

istream - is an input stream to get a script from

filename - filename is used as in information, for example, appears in a stack trace of an exception

lines - are linenumbers to display for parse errors and backtraces. This field is optional. Only the first argument is used for parsing. When no line number is specified, 0 is applied to.

Returns:

an object which can be run