Package org.jruby.internal.runtime.methods

Enum Class CallConfiguration

java.lang.Object

java.lang.Enum<CallConfiguration>

org.jruby.internal.runtime.methods.CallConfiguration

All Implemented Interfaces:

Serializable, Comparable<CallConfiguration>, Constable

public enum CallConfiguration
extends Enum<CallConfiguration>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FrameBacktraceScopeDummy
FrameBacktraceScopeFull
FrameBacktraceScopeNone
FrameFullScopeDummy
FrameFullScopeFull
FrameFullScopeNone
FrameNoneScopeDummy
FrameNoneScopeFull
FrameNoneScopeNone

Field Summary

Fields

Modifier and Type	Field	Description
static final CallConfiguration	BACKTRACE_AND_SCOPE	Deprecated.
static final CallConfiguration	BACKTRACE_DUMMY_SCOPE	Deprecated.
static final CallConfiguration	BACKTRACE_ONLY	Deprecated.
static final CallConfiguration	FRAME_AND_DUMMY_SCOPE	Deprecated.
static final CallConfiguration	FRAME_AND_SCOPE	Deprecated.
static final CallConfiguration	FRAME_ONLY	Deprecated.
static final CallConfiguration	NO_FRAME_DUMMY_SCOPE	Deprecated.
static final CallConfiguration	NO_FRAME_NO_SCOPE	Deprecated.
static final CallConfiguration	SCOPE_ONLY	Deprecated.

Method Summary

Modifier and Type	Method	Description
final Framing	framing()
static CallConfiguration	getCallConfig(boolean frame)	Given a frame and scope requirement, return the name of the appropriate CallConfiguration.
static CallConfiguration	getCallConfig(boolean frame, boolean scope)	Deprecated.
static CallConfiguration	getCallConfig(boolean frame, boolean scope, boolean backtrace)	Deprecated.
static CallConfiguration	getCallConfigByAnno(JRubyMethod anno)	Produce a CallConfiguration name that represents what must be prepared around calls to the method with this annotation.
static CallConfiguration	getCallerCallConfigByAnno(JRubyMethod jrubyMethod)	Produce a CallConfiguration that represents what *caller* methods must prepare for the method with this annotation.
final Scoping	scoping()
static CallConfiguration	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CallConfiguration[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FrameFullScopeFull

public static final CallConfiguration FrameFullScopeFull

FrameFullScopeDummy

public static final CallConfiguration FrameFullScopeDummy

FrameFullScopeNone

public static final CallConfiguration FrameFullScopeNone

FrameBacktraceScopeFull

public static final CallConfiguration FrameBacktraceScopeFull

FrameBacktraceScopeDummy

public static final CallConfiguration FrameBacktraceScopeDummy

FrameBacktraceScopeNone

public static final CallConfiguration FrameBacktraceScopeNone

FrameNoneScopeFull

public static final CallConfiguration FrameNoneScopeFull

FrameNoneScopeDummy

public static final CallConfiguration FrameNoneScopeDummy

FrameNoneScopeNone

public static final CallConfiguration FrameNoneScopeNone

Field Details

FRAME_AND_SCOPE

@Deprecated
public static final CallConfiguration FRAME_AND_SCOPE

Deprecated.

FRAME_AND_DUMMY_SCOPE

@Deprecated
public static final CallConfiguration FRAME_AND_DUMMY_SCOPE

Deprecated.

FRAME_ONLY

@Deprecated
public static final CallConfiguration FRAME_ONLY

Deprecated.

BACKTRACE_AND_SCOPE

@Deprecated
public static final CallConfiguration BACKTRACE_AND_SCOPE

Deprecated.

BACKTRACE_DUMMY_SCOPE

@Deprecated
public static final CallConfiguration BACKTRACE_DUMMY_SCOPE

Deprecated.

BACKTRACE_ONLY

@Deprecated
public static final CallConfiguration BACKTRACE_ONLY

Deprecated.

SCOPE_ONLY

@Deprecated
public static final CallConfiguration SCOPE_ONLY

Deprecated.

NO_FRAME_DUMMY_SCOPE

@Deprecated
public static final CallConfiguration NO_FRAME_DUMMY_SCOPE

Deprecated.

NO_FRAME_NO_SCOPE

@Deprecated
public static final CallConfiguration NO_FRAME_NO_SCOPE

Deprecated.

Method Details

values

public static CallConfiguration[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CallConfiguration valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getCallerCallConfigByAnno

public static CallConfiguration getCallerCallConfigByAnno(JRubyMethod jrubyMethod)

Produce a CallConfiguration that represents what *caller* methods must prepare for the method with this annotation.

See Also:

• AnnotationHelper.getCallerCallConfigNameByAnno(org.jruby.anno.JRubyMethod)

getCallConfigByAnno

public static CallConfiguration getCallConfigByAnno(JRubyMethod anno)

Produce a CallConfiguration name that represents what must be prepared around calls to the method with this annotation.

getCallConfig

public static CallConfiguration getCallConfig(boolean frame)

Given a frame and scope requirement, return the name of the appropriate CallConfiguration.

See Also:

• AnnotationHelper.getCallConfigName(boolean, boolean)

framing

public final Framing framing()

scoping

public final Scoping scoping()

getCallConfig

@Deprecated
public static CallConfiguration getCallConfig(boolean frame,
 boolean scope,
 boolean backtrace)

Deprecated.

getCallConfig

@Deprecated
public static CallConfiguration getCallConfig(boolean frame,
 boolean scope)

Deprecated.

Given a frame and scope requirement, return the name of the appropriate CallConfiguration.

See Also:

• AnnotationHelper.getCallConfigName(boolean, boolean)