Module org.jruby.base
Package org.jruby.anno

Annotation Interface JRubyMethod

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

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    alias
    Any alias or aliases for this method.
    Class[]
    argTypes
    Argument types to coerce to before calling
    boolean
    backtrace
    Deprecated.
    boolean
    checkArity
    Whether automatic arity-checking should be added to the Ruby binding for this method.
    boolean
    frame
    Whether this method expects to have a call frame allocated for it.
    Class[]
    implementers
    A list of classes that implement an abstract JRubyMethod, for backtrace purposes.
    boolean
    keywords
    Whether this method may recieve keyword arguments.
    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.
    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
    Deprecated.
    Visibility
    visibility
    The visibility of this method.
    FrameField[]
    writes
    What, if anything, method writes to caller's frame

  • Element Details

    • name

      String[] name
      The name or names of this method in Ruby-land.
      Default:
      {}

    • required

      int required
      The number of required arguments.
      Default:
      0

    • optional

      int optional
      The number of optional arguments.
      Default:
      0

    • rest

      boolean rest
      Whether this method has a "rest" argument.
      Default:
      false

    • alias

      String[] alias
      Any alias or aliases for this method.
      Default:
      {}

    • meta

      boolean meta
      Whether this method should be defined on the metaclass.
      Default:
      false

    • module

      boolean module
      Whether this method should be a module function, defined on metaclass and private on class.
      Default:
      false

    • keywords

      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.
      Default:
      false

    • frame

      boolean frame
      Whether this method expects to have a call frame allocated for it.
      Default:
      false

    • visibility

      Visibility visibility
      The visibility of this method.
      Default:
      DEFAULT

    • reads

      FrameField[] reads
      What, if anything, method reads from caller's frame
      Default:
      {}

    • writes

      FrameField[] writes
      What, if anything, method writes to caller's frame
      Default:
      {}

    • argTypes

      Class[] argTypes
      Argument types to coerce to before calling
      Default:
      {}

    • omit

      boolean omit
      Whether to use a frame slot for backtrace information
      Default:
      false

    • notImplemented

      boolean notImplemented
      Whether this method should show up as defined in response to respond_to? calls
      Default:
      false

    • checkArity

      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.
      Default:
      true

    • implementers

      Class[] implementers
      A list of classes that implement an abstract JRubyMethod, for backtrace purposes.
      Default:
      {}

    • scope

      @Deprecated(since="9.2.0.0") boolean scope
      Deprecated.
      Default:
      false

    • backtrace

      @Deprecated(since="9.2.0.0") boolean backtrace
      Deprecated.
      Default:
      false