org.jruby.anno
Annotation Type JRubyMethod


@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface JRubyMethod

Author:
headius

Optional Element Summary
 java.lang.String[] alias
          Any alias or aliases for this method.
 java.lang.Class[] argTypes
          Argument types to coerce to before calling
 boolean backtrace
          Whether to use a frame slot for backtrace information
 CompatVersion compat
          Whether this method is specific to Ruby 1.9
 boolean frame
          Whether this method expects to have a call frame allocated for it.
 boolean meta
          Whether this method should be defined on the metaclass.
 boolean module
          Whether this method should be a module function, defined on metaclass and private on class.
 java.lang.String[] name
          The name or names of this method in Ruby-land.
 boolean notImplemented
          Whether this method should show up as defined in response to respond_to? calls
 boolean omit
          Whether to use a frame slot for backtrace information
 int optional
          The number of optional arguments.
 FrameField[] reads
          What, if anything, method reads from caller's frame
 int required
          The number of required arguments.
 boolean rest
          Whether this method has a "rest" argument.
 boolean scope
          Whether this method expects to have a heap-based variable scope allocated for it.
 Visibility visibility
          The visibility of this method.
 FrameField[] writes
          What, if anything, method writes to caller's frame
 

name

public abstract java.lang.String[] name
The name or names of this method in Ruby-land.

Default:
{}

required

public abstract int required
The number of required arguments.

Default:
0

optional

public abstract int optional
The number of optional arguments.

Default:
0

rest

public abstract boolean rest
Whether this method has a "rest" argument.

Default:
false

alias

public abstract java.lang.String[] alias
Any alias or aliases for this method.

Default:
{}

meta

public abstract boolean meta
Whether this method should be defined on the metaclass.

Default:
false

module

public abstract boolean module
Whether this method should be a module function, defined on metaclass and private on class.

Default:
false

frame

public abstract boolean frame
Whether this method expects to have a call frame allocated for it.

Default:
false

scope

public abstract boolean scope
Whether this method expects to have a heap-based variable scope allocated for it.

Default:
false

compat

public abstract CompatVersion compat
Whether this method is specific to Ruby 1.9

Default:
org.jruby.CompatVersion.BOTH

visibility

public abstract Visibility visibility
The visibility of this method.

Default:
org.jruby.runtime.Visibility.PUBLIC

backtrace

public abstract boolean backtrace
Whether to use a frame slot for backtrace information

Default:
false

reads

public abstract FrameField[] reads
What, if anything, method reads from caller's frame

Default:
{}

writes

public abstract FrameField[] writes
What, if anything, method writes to caller's frame

Default:
{}

argTypes

public abstract java.lang.Class[] argTypes
Argument types to coerce to before calling

Default:
{}

omit

public abstract boolean omit
Whether to use a frame slot for backtrace information

Default:
false

notImplemented

public abstract boolean notImplemented
Whether this method should show up as defined in response to respond_to? calls

Default:
false


Copyright © 2002-2009 JRuby Team. All Rights Reserved.