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 - org.opalj.bi) that can be used to create arbitrary representations.
a library to create a one-to-one in-memory representation of Java bytecode (Bytecode Disassembler - org.opalj.da).
a library to convert this representation to Java class files (Bytecode Creator - org.opalj.bc).
a library to create a representation of Java bytecode that facilitates writing simple static analyses (Bytecode Representation - org.opalj.br).
a library to create a stackless, three-address code representation of Java bytecode that facilitates writing complex static analyses (Three Address Code - org.opalj.tac).
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 (Dependencies Extraction - org.opalj.de) and to facilitate checking architecture definitions (Architecture Validation - org.opalj.av).
a library for the lightweight manipulation and creation of Java bytecode (Bytecode Assembler - org.opalj.ba).
a library for parsing Android packages (APK - org.opalj.apk).
libraries for writing static analyses using the interprocedural finite distributive subset (IFDS - org.opalj.ifds) and interprocedural distributive environment (IDE - org.opal.ide) algorithms.

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 cli

Definition Classes: opalj

Arg

LibrariesAsInterfacesArg

NoDynamicConstantRewriteArg

NoInvokeDynamicRewriteArg

NoJDKArg

NoLogsArg

NoRewriteArg

OPALCommandLineConfig

OPALCommandLineConfig

trait OPALCommandLineConfig extends AnyRef

OpalConf is a utility trait designed to enhance the ScallopConf functionality by providing additional methods for handling command-line argument parsing in the OPAL framework. This trait is intended to be mixed into ScallopConf configurations, enabling more customized parsing mechanisms with reusable methods for specific command types and error handling.

Self Type: OPALCommandLineConfig with ScallopConf
Source: OPALCommandLineConfig.scala

Linear Supertypes

AnyRef, Any

Known Subclasses

AIBasedCommandLineConfig, DependenciesConfig, InstructionStatisticsConfig, MethodFilterConfig, MethodAnalysisConfig, MultiProjectAnalysisConfig, ProjectBasedCommandLineConfig, PropertyStoreBasedCommandLineConfig, TACConfig, CGBasedCommandLineConfig, IFDSRunnerConfig

Ordering

Alphabetic
By Inheritance

Inherited

OPALCommandLineConfig
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Type Members

implicit class CommandExt extends AnyRef
Attributes
protected

Abstract Value Members

abstract val description: String

Concrete 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[R](arg: Arg[_, R]): R
Gets the value of a (required) argument.
Gets the value of a (required) argument.
Exceptions thrown
NoSuchElementException if the argument was not supplied (which means it was not marked as required!)
val argGroups: Map[Arg[_, _], ScallopOptionGroup]
Attributes
protected
def args(as: Arg[_, _]*): Unit
Defines (additional) args for this configuration
Defines (additional) args for this configuration
Attributes
protected
def argsIterator: Iterator[Arg[_, _]]
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
def generalArgs(as: Arg[_, _]*): Unit
Defines (additional) general args for this configuration
Defines (additional) general args for this configuration
Attributes
protected
def get[R](arg: Arg[_, R], default: => R): R
Gets the value of an (optional) argument or a default value if the argument was not supplied
def get[R](arg: Arg[_, R]): Option[R]
Gets the value of an (optional) argument or None if the argument was not supplied
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
def init(): Unit
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
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()
def onError(e: Throwable): Unit
Attributes
protected
def setupConfig(isLibrary: Boolean): Config
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
Deprecated

Packages

General Design Decisions

Thread Safety

No `null` Values

No Typecasts for Collections

Assertions

OPALCommandLineConfig

trait OPALCommandLineConfig extends AnyRef

Type Members

Abstract Value Members

Concrete 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

OPALCommandLineConfig

trait OPALCommandLineConfig extends AnyRef

Type Members

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

No `null` Values

OPALCommandLineConfig