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 collection

  OPAL's collection library is primarily designed with high performance in mind.

  Design Goals

  OPAL's collection library is primarily designed with high performance in mind. I.e., all methods provided by the collection library are reasonably optimized. However, providing a very large number of methods is a non-goal. Overall, OPAL's collection library provides:

  • collection classes that are manually specialized for primitive data-types.
  • collection classes that are optimized for particularly small collections of values.
  • collection classes that target special use cases such as using a collection as a workset/worklist.
  • collection classes that offer special methods that minimize the number of steps when compared to general purpose methods.

  Integration With Scala's Collection Library

  Hence, OPAL's collection library complements Scala's default collection library and is not intended to replace it. Integration with Scala's collection library is primarily provided by means of iterators (OPAL's Iterators inherit from Scala's Iterators). Furthermore the companion object of each of OPAL's collection classes generally provides factory methods that facilitate the conversion from Scala collection classes to OPAL collection classes.

  Status

  The collection library is growing. Nevertheless, the existing classes are production ready.

  Definition Classes

  opalj

•  package immutable

  Definition Classes

  collection

• BitArraySet
• EmptyIntArraySet
• EmptyIntList
• EmptyIntTrieSet
• FilteredIntTrieSet
• IdentityPair
• Int2List
• Int2ListEnd
• Int2ListNode
• IntArraySet
• IntArraySet1
• IntArraySetBuilder
• IntArraySetN
• IntIntPair
• IntList
• IntListNode
• IntRefPair
• IntTrieSet
• IntTrieSet1
• IntTrieSetBuilder
• IntWorkSet
• LargeLongLinkedTrieSet
• Long2List
• Long2List0
• LongLinkedSet
• LongLinkedTrieSet
• LongLinkedTrieSet0
• LongLinkedTrieSet1
• LongLinkedTrieSetN4
• LongList
• LongList0
• LongListNode
• LongRefPair
• LongTrieSet
• LongTrieSetWithList
• LongWorkSet
• NonEmptyUIDSet
• Pair
• Ref2List
• RefIntPair
• UIDSet
• UIDSet0
• UIDSet1
• UIDSet2
• UIDSet3
• UIDSetInnerNode
• UIDSetLeaf
• UIDTrieSet
• UIDTrieSet0
• UIDTrieSet1
• UShortPair

org.opalj.collection.immutable

LongRefPair