Packages

Definition Classes: root

Definition Classes: root

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 fpcf

Definition Classes: br

package properties

Definition Classes: fpcf

package immutability

Definition Classes: properties

package pointsto

Definition Classes: properties

AggregatableValueProperty

AggregatedProperty

AllocationFreeMethod

AllocationFreeness

AllocationFreenessPropertyMetaInformation

AtMost

CallStringContext

CallStringContexts

CallStringContextsKey

ClassifiedImpure

CompileTimeConstancy

CompileTimeConstancyPropertyMetaInformation

CompileTimeConstantField

CompileTimePure

CompileTimeVaryingField

Context

ContextuallyPure

ContextuallySideEffectFree

DContextuallyPure

DContextuallySideEffectFree

DPure

DSideEffectFree

DoesNotLeakSelfReference

EscapeInCallee

EscapeProperty

EscapePropertyMetaInformation

EscapeViaAbnormalReturn

EscapeViaHeapObject

EscapeViaNormalAndAbnormalReturn

EscapeViaParameter

EscapeViaParameterAndAbnormalReturn

EscapeViaParameterAndNormalAndAbnormalReturn

EscapeViaParameterAndReturn

ExtensibleLocalFieldWithGetter

FieldLocality

FieldLocalityMetaInformation

ImpureByLackOfInformation

MethodComplexityPropertyMetaInformation

MethodWithAllocations

PurityPropertyMetaInformation

ReturnValueFreshness

ReturnValueFreshnessPropertyMetaInformation

StaticDataUsagePropertyMetaInformation

SystemProperties

SystemPropertiesPropertyMetaInformation

ThrownExceptions

ThrownExceptionsByOverridingMethods

ThrownExceptionsByOverridingMethodsPropertyMetaInformation

ThrownExceptionsFallback

ThrownExceptionsPropertyMetaInformation

VPrimitiveReturnValue

VirtualMethodAllocationFreeness

VirtualMethodAllocationFreenessPropertyMetaInformation

VirtualMethodEscapeProperty

VirtualMethodEscapePropertyMetaInformation

VirtualMethodPurity

VirtualMethodPurityPropertyMetaInformation

VirtualMethodReturnValueFreshness

VirtualMethodReturnValueFreshnessMetaInformation

VirtualMethodStaticDataUsage

VirtualMethodStaticDataUsagePropertyMetaInformation

org.opalj.br.fpcf.properties

VirtualMethodEscapeProperty

Companion class VirtualMethodEscapeProperty

object VirtualMethodEscapeProperty extends VirtualMethodEscapePropertyMetaInformation with Serializable

Represents the EscapeProperty for org.opalj.br.analyses.VirtualFormalParameter objects as entity. The underlying property is an aggregation of escape properties of the underlying parameters of the concrete methods.

Source: VirtualMethodEscapeProperty.scala

Linear Supertypes

Serializable, VirtualMethodEscapePropertyMetaInformation, PropertyMetaInformation, PropertyKind, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

VirtualMethodEscapeProperty
Serializable
VirtualMethodEscapePropertyMetaInformation
PropertyMetaInformation
PropertyKind
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Type Members

final type Self = VirtualMethodEscapeProperty
Definition Classes
VirtualMethodEscapePropertyMetaInformation → PropertyMetaInformation

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
final val VAtMostEscapeInCallee: VirtualMethodEscapeProperty
final val VAtMostEscapeViaAbnormalReturn: VirtualMethodEscapeProperty
final val VAtMostEscapeViaNormalAndAbnormalReturn: VirtualMethodEscapeProperty
final val VAtMostEscapeViaParameter: VirtualMethodEscapeProperty
final val VAtMostEscapeViaParameterAndAbnormalReturn: VirtualMethodEscapeProperty
final val VAtMostEscapeViaParameterAndNormalAndAbnormalReturn: VirtualMethodEscapeProperty
final val VAtMostEscapeViaParameterAndReturn: VirtualMethodEscapeProperty
final val VAtMostEscapeViaReturn: VirtualMethodEscapeProperty
final val VAtMostNoEscape: VirtualMethodEscapeProperty
final val VEscapeInCallee: VirtualMethodEscapeProperty
final val VEscapeViaAbnormalReturn: VirtualMethodEscapeProperty
final val VEscapeViaHeapObject: VirtualMethodEscapeProperty
final val VEscapeViaNormalAndAbnormalReturn: VirtualMethodEscapeProperty
final val VEscapeViaParameter: VirtualMethodEscapeProperty
final val VEscapeViaParameterAndAbnormalReturn: VirtualMethodEscapeProperty
final val VEscapeViaParameterAndNormalAndAbnormalReturn: VirtualMethodEscapeProperty
final val VEscapeViaParameterAndReturn: VirtualMethodEscapeProperty
final val VEscapeViaReturn: VirtualMethodEscapeProperty
final val VEscapeViaStaticField: VirtualMethodEscapeProperty
final val VGlobalEscape: VirtualMethodEscapeProperty
final val VNoEscape: VirtualMethodEscapeProperty
def apply(escapeProperty: EscapeProperty): VirtualMethodEscapeProperty
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 id: Int
The id uniquely identifies this property's category.
The id uniquely identifies this property's category. All property objects of the same kind have to use the same id which is guaranteed since they share the same PropertyKey
Definition Classes
PropertyMetaInformation → PropertyKind
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final val key: PropertyKey[VirtualMethodEscapeProperty]
The key uniquely identifies this property's category.
The key uniquely identifies this property's category. All property objects of the same kind have to use the same key.
In general each Property kind is expected to have a companion object that stores the unique PropertyKey.
Definition Classes
VirtualMethodEscapeProperty → PropertyMetaInformation
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
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

VirtualMethodEscapeProperty

Companion class VirtualMethodEscapeProperty

object VirtualMethodEscapeProperty extends VirtualMethodEscapePropertyMetaInformation with Serializable

Type Members

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from VirtualMethodEscapePropertyMetaInformation

Inherited from PropertyMetaInformation

Inherited from PropertyKind

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

General Design Decisions

Thread Safety

No null Values

No Typecasts for Collections

Assertions

VirtualMethodEscapeProperty

Companion class VirtualMethodEscapeProperty

object VirtualMethodEscapeProperty extends VirtualMethodEscapePropertyMetaInformation with Serializable

Type Members

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from VirtualMethodEscapePropertyMetaInformation

Inherited from PropertyMetaInformation

Inherited from PropertyKind

Inherited from AnyRef

Inherited from Any

Ungrouped

No `null` Values

VirtualMethodEscapeProperty