The OPAL Framework5.0.0 < Back

Packages

package root
Definition Classes
root
package org
Definition Classes
root
package opalj
OPAL is a Scala-based framework for the static analysis, manipulation and creation of Java bytecode.
OPAL is a Scala-based framework for the static analysis, manipulation and creation of Java bytecode. OPAL is designed with performance, scalability and adaptability in mind.
Its main components are:
- a library (Common) which provides generally useful data-structures and algorithms for static analyses.
- a framework for implementing lattice based static analyses (Static Analysis Infrastructure)
- a framework for parsing Java bytecode (Bytecode Infrastructure) that can be used to create arbitrary representations.
- a library to create a one-to-one in-memory representation of Java bytecode (Bytecode Disassembler).
- a library to create a representation of Java bytecode that facilitates writing simple static analyses (Bytecode Representation - org.opalj.br).
- a scalable, easily customizable framework for the abstract interpretation of Java bytecode (Abstract Interpretation Framework - org.opalj.ai).
- a library to extract dependencies between code elements and to facilitate checking architecture definitions.
- a library for the lightweight manipulation and creation of Java bytecode (Bytecode Assembler).
General Design Decisions
Thread Safety
Unless explicitly noted, OPAL is thread safe. I.e., the classes defined by OPAL can be considered to be thread safe unless otherwise stated. (For example, it is possible to read and process class files concurrently without explicit synchronization on the client side.)
No null Values
Unless explicitly noted, OPAL does not null values I.e., fields that are accessible will never contain null values and methods will never return null. If a method accepts null as a value for a parameter or returns a null value it is always explicitly documented. In general, the behavior of methods that are passed null values is undefined unless explicitly documented.
No Typecasts for Collections
For efficiency reasons, OPAL sometimes uses mutable data-structures internally. After construction time, these data-structures are generally represented using their generic interfaces (e.g., scala.collection.{Set,Map}). However, a downcast (e.g., to add/remove elements) is always forbidden as it would effectively prevent thread-safety.
Assertions
OPAL makes heavy use of Scala's Assertion Facility to facilitate writing correct code. Hence, for production builds (after thorough testing(!)) it is highly recommend to build OPAL again using -Xdisable-assertions.
Definition Classes
org
package br
In this representation of Java bytecode references to a Java class file's constant pool and to attributes are replaced by direct references to the corresponding constant pool entries.
In this representation of Java bytecode references to a Java class file's constant pool and to attributes are replaced by direct references to the corresponding constant pool entries. This facilitates developing analyses and fosters comprehension.
Based on the fact that indirect references to constant pool entries are resolved and replaced by direct references this representation is called the resolved representation.
This representation of Java bytecode is considered as OPAL's standard representation for writing Scala based analyses. This representation is engineered such that it facilitates writing analyses that use pattern matching.
Definition Classes
opalj
package instructions
Common instruction sequences.
Common instruction sequences.
Definition Classes
br
AALOAD
AASTORE
ACONST_NULL
ALOAD
ALOAD_0
ALOAD_1
ALOAD_2
ALOAD_3
ALoadInstruction
ANEWARRAY
ARETURN
ARRAYLENGTH
ASTORE
ASTORE_0
ASTORE_1
ASTORE_2
ASTORE_3
AStoreInstruction
ATHROW
AddInstruction
AlwaysSucceedingStackBasedBinaryArithmeticInstruction
ArithmeticInstruction
ArrayAccessInstruction
ArrayLoadInstruction
ArrayStoreInstruction
BALOAD
BASTORE
BIPUSH
BitwiseInstruction
BranchoffsetOutOfBoundsException
CALOAD
CASTORE
CHECKCAST
ClassFileFactory
ComparisonInstruction
CompoundConditionalBranchInstruction
CompoundConditionalBranchInstructionLike
ConditionalBranchInstruction
ConditionalBranchInstructionLike
ConstantALoadInstruction
ConstantIndexAStoreInstruction
ConstantIndexDLoadInstruction
ConstantIndexDStoreInstruction
ConstantIndexFLoadInstruction
ConstantIndexFStoreInstruction
ConstantIndexILoadInstruction
ConstantIndexIStoreInstruction
ConstantIndexLLoadInstruction
ConstantIndexLStoreInstruction
ConstantLengthInstruction
ConstantLengthInstructionLike
ControlTransferInstruction
ControlTransferInstructionLike
CreateNewArrayInstruction
CreateNewOneDimensionalArrayInstruction
D2F
D2I
D2L
DADD
DALOAD
DASTORE
DCMPG
DCMPL
DCONST_0
DCONST_1
DConstInstruction
DDIV
DEFAULT_INVOKEDYNAMIC
DLOAD
DLOAD_0
DLOAD_1
DLOAD_2
DLOAD_3
DLoadInstruction
DMUL
DNEG
DREM
DRETURN
DSTORE
DSTORE_0
DSTORE_1
DSTORE_2
DSTORE_3
DSUB
DStoreInstruction
DUP
DUP2
DUP2_X1
DUP2_X2
DUP_X1
DUP_X2
DivideInstruction
ExplicitLocalVariableIndex
ExpressionResultLocation
F2D
F2I
F2L
FADD
FALOAD
FASTORE
FCMPG
FCMPL
FCONST_0
FCONST_1
FCONST_2
FConstInstruction
FDIV
FLOAD
FLOAD_0
FLOAD_1
FLOAD_2
FLOAD_3
FLoadInstruction
FMUL
FNEG
FREM
FRETURN
FSTORE
FSTORE_0
FSTORE_1
FSTORE_2
FSTORE_3
FSUB
FStoreInstruction
FieldAccess
FieldReadAccess
FieldWriteAccess
FloatingPointDivideInstruction
FloatingPointRemainderInstruction
GETFIELD
GETSTATIC
GOTO
GOTOLike
GOTO_W
GOTO_WLike
GotoInstruction
GotoInstructionLike
I2B
I2C
I2D
I2F
I2L
I2S
IADD
IALOAD
IAND
IASTORE
ICONST_0
ICONST_1
ICONST_2
ICONST_3
ICONST_4
ICONST_5
ICONST_M1
IConstInstruction
IDIV
IF0Instruction
IF0InstructionLike
IFACMPInstruction
IFACMPInstructionLike
IFEQ
IFEQLike
IFGE
IFGELike
IFGT
IFGTLike
IFICMPInstruction
IFICMPInstructionLike
IFLE
IFLELike
IFLT
IFLTLike
IFNE
IFNELike
IFNONNULL
IFNONNULLLike
IFNULL
IFNULLLike
IFXNullInstruction
IFXNullInstructionLike
IF_ACMPEQ
IF_ACMPEQLike
IF_ACMPNE
IF_ACMPNELike
IF_ICMPEQ
IF_ICMPEQLike
IF_ICMPGE
IF_ICMPGELike
IF_ICMPGT
IF_ICMPGTLike
IF_ICMPLE
IF_ICMPLELike
IF_ICMPLT
IF_ICMPLTLike
IF_ICMPNE
IF_ICMPNELike
IINC
ILOAD
ILOAD_0
ILOAD_1
ILOAD_2
ILOAD_3
ILoadInstruction
IMUL
INCOMPLETE_INVOKEDYNAMIC
INCOMPLETE_LDC
INCOMPLETE_LDC2_W
INCOMPLETE_LDC_W
INEG
INSTANCEOF
INVOKEDYNAMIC
INVOKEINTERFACE
INVOKESPECIAL
INVOKESTATIC
INVOKEVIRTUAL
IOR
IREM
IRETURN
ISHL
ISHR
ISTORE
ISTORE_0
ISTORE_1
ISTORE_2
ISTORE_3
ISUB
IStoreInstruction
IUSHR
IXOR
ImplicitLocalVariableIndex
ImplicitValue
Instruction
InstructionLabel
InstructionLike
InstructionMetaInformation
IntegerDivideInstruction
IntegerRemainderInstruction
InvocationInstruction
JSR
JSRInstruction
JSRInstructionLike
JSRLike
JSR_W
JSR_WLike
L2D
L2F
L2I
LADD
LALOAD
LAND
LASTORE
LCMP
LCONST_0
LCONST_1
LConstInstruction
LDC
LDC2_W
LDCClass
LDCDynamic
LDCFloat
LDCInt
LDCMethodHandle
LDCMethodType
LDCString
LDC_W
LDIV
LLOAD
LLOAD_0
LLOAD_1
LLOAD_2
LLOAD_3
LLoadInstruction
LMUL
LNEG
LOOKUPSWITCH
LOOKUPSWITCHLike
LOR
LREM
LRETURN
LSHL
LSHR
LSTORE
LSTORE_0
LSTORE_1
LSTORE_2
LSTORE_3
LSUB
LStoreInstruction
LUSHR
LXOR
LabeledGOTO
LabeledGOTO_W
LabeledIFEQ
LabeledIFGE
LabeledIFGT
LabeledIFLE
LabeledIFLT
LabeledIFNE
LabeledIFNONNULL
LabeledIFNULL
LabeledIF_ACMPEQ
LabeledIF_ACMPNE
LabeledIF_ICMPEQ
LabeledIF_ICMPGE
LabeledIF_ICMPGT
LabeledIF_ICMPLE
LabeledIF_ICMPLT
LabeledIF_ICMPNE
LabeledInstruction
LabeledJSR
LabeledJSR_W
LabeledLOOKUPSWITCH
LabeledSimpleConditionalBranchInstruction
LabeledSingleJumpTargetInstruction
LabeledTABLESWITCH
LabeledUnconditionalBranchInstruction
LoadClass
LoadClass_W
LoadConstantInstruction
LoadDouble
LoadDynamic
LoadDynamic2_W
LoadDynamic_W
LoadFloat
LoadFloat_W
LoadInt
LoadInt_W
LoadLocalVariableInstruction
LoadLong
LoadMethodHandle
LoadMethodHandle_W
LoadMethodType
LoadMethodType_W
LoadString
LoadString_W
LocalVariableAccess
MONITORENTER
MONITOREXIT
MULTIANEWARRAY
MethodCompletionInstruction
MethodInvocationInstruction
MultiplyInstruction
NEW
NEWARRAY
NOP
NamedLabel
NegateInstruction
NoExpression
NoMethodCompletionInstruction
NonVirtualMethodInvocationInstruction
NumericConversionInstruction
PCLabel
POP
POP2
PUTFIELD
PUTSTATIC
PopInstruction
PrimitiveArrayAccess
PrimitiveArrayStoreInstruction
PrimitiveLDC
PrimitiveLDC_W
RET
RETURN
Register
RemainderInstruction
ReturnInstruction
ReturnInstructions
ReturnValueInstruction
RewriteLabel
SALOAD
SASTORE
SIPUSH
SWAP
ShiftInstruction
SimpleBranchInstruction
SimpleBranchInstructionLike
SimpleConditionalBranchInstruction
SimpleConditionalBranchInstructionLike
Stack
StackBasedArithmeticInstruction
StackBasedBinaryArithmeticInstruction
StackManagementInstruction
StoreLocalVariableInstruction
SubtractInstruction
SwitchInstruction
SynchronizationInstruction
TABLESWITCH
TABLESWITCHLike
UnaryArithmeticInstruction
UnconditionalBranchInstruction
UnconditionalBranchInstructionLike
VirtualMethodInvocationInstruction
WIDE

org.opalj.br.instructions

ReturnInstruction

Companion class ReturnInstruction

object ReturnInstruction

Defines common values and a factory method to create a ReturnInstruction based on the expected type.

Source: ReturnInstruction.scala

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

ReturnInstruction
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def apply(theType: Type): ReturnInstruction
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
val jvmExceptions: List[ObjectType]
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
def unapply(instruction: Instruction): Option[ReturnInstruction]
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated

Packages

General Design Decisions

Thread Safety

No `null` Values

No Typecasts for Collections

Assertions

ReturnInstruction

Companion class ReturnInstruction

object ReturnInstruction

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

General Design Decisions

Thread Safety

No null Values

No Typecasts for Collections

Assertions

ReturnInstruction

Companion class ReturnInstruction

object ReturnInstruction

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

No `null` Values

ReturnInstruction