org.jruby.anno

public @Interface JRubyMethod

Annotations

extends Annotation

@Retention:RUNTIME
@Target:METHOD

Imports

java.lang.annotation.ElementType, .Retention, .RetentionPolicy, .Target, org.jruby.runtime.Visibility

Method Summary

Modifier and Type	Method and Description
public String[]	alias() Any alias or aliases for this method.
public Class<T>[]	argTypes() Argument types to coerce to before calling
public boolean	backtrace() Deprecated
public boolean	checkArity() Whether automatic arity-checking should be added to the Ruby binding for this method.
public boolean	frame() Whether this method expects to have a call frame allocated for it.
public Class<T>[]	implementers() A list of classes that implement an abstract JRubyMethod, for backtrace purposes.
public boolean	keywords() Whether this method may recieve keyword arguments.
public boolean	meta() Whether this method should be defined on the metaclass.
public boolean	module() Whether this method should be a module function, defined on metaclass and private on class.
public String[]	name() The name or names of this method in Ruby-land.
public boolean	notImplemented() Whether this method should show up as defined in response to respond_to?
public boolean	omit() Whether to use a frame slot for backtrace information
public int	optional() The number of optional arguments.
public FrameField[]	reads() What, if anything, method reads from caller's frame
public int	required() The number of required arguments.
public boolean	rest() Whether this method has a "rest" argument.
public boolean	scope() Deprecated
public Visibility	visibility() The visibility of this method.
public FrameField[]	writes() What, if anything, method writes to caller's frame

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

alias	back to summary
public String[] alias() Any alias or aliases for this method.

argTypes	back to summary
public Class<T>[] argTypes() Argument types to coerce to before calling

backtrace	back to summary
public boolean backtrace() Deprecated Annotations @Deprecated

checkArity	back to summary
public boolean checkArity() Whether automatic arity-checking should be added to the Ruby binding for this method. Users can opt-out and do their own arity-checking in the method body.

frame	back to summary
public boolean frame() Whether this method expects to have a call frame allocated for it.

implementers	back to summary
public Class<T>[] implementers() A list of classes that implement an abstract JRubyMethod, for backtrace purposes.

keywords	back to summary
public boolean keywords() Whether this method may recieve keyword arguments. Methods may directly process the keywords or decide to pass them on to a subcall. This will determine whether ThreadContext#callInfo will get reset before the call begins or not. If keywords is true then it is the methods job to reset or not reset callInfo.

meta	back to summary
public boolean meta() Whether this method should be defined on the metaclass.

module	back to summary
public boolean module() Whether this method should be a module function, defined on metaclass and private on class.

name	back to summary
public String[] name() The name or names of this method in Ruby-land.

notImplemented	back to summary
public boolean notImplemented() Whether this method should show up as defined in response to respond_to? calls

omit	back to summary
public boolean omit() Whether to use a frame slot for backtrace information

optional	back to summary
public int optional() The number of optional arguments.

reads	back to summary
public FrameField[] reads() What, if anything, method reads from caller's frame

required	back to summary
public int required() The number of required arguments.

rest	back to summary
public boolean rest() Whether this method has a "rest" argument.

scope	back to summary
public boolean scope() Deprecated Annotations @Deprecated

visibility	back to summary
public Visibility visibility() The visibility of this method.

writes	back to summary
public FrameField[] writes() What, if anything, method writes to caller's frame