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

final case class IdentityPair[+T1 <: AnyRef, +T2 <: AnyRef](_1: T1, _2: T2) extends Product2[T1, T2] with Product with Serializable

Encapsulates a pair of values that is intended to be used as a key in Maps. Compared to a standard pair (Tuple2), however, comparison of two IdentityPair objects is done by doing a reference-based comparison of the stored values.

_1

A reference value (can be null).

_2

A reference value (can be null).

Source
IdentityPair.scala
Example:

  1. val a = new String("fooBar")
val b = "foo"+"Bar"
val p1 = new IdentityPair(a,b) // #1
val p2 = new IdentityPair(a,a) // #2
val p3 = new IdentityPair(a,b) // #3
p1 == p2 // => false (though (a,b) == (a,a) would be true
p1 == p3 // => true
Linear Supertypes
Serializable, Product2[T1, T2], Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IdentityPair
  2. Serializable
  3. Product2
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new IdentityPair(_1: T1, _2: T2)

    _1

    A reference value (can be null).

    _2

    A reference value (can be null).

Value Members

  1. val _1: T1
    Definition Classes
    IdentityPair → Product2
  2. val _2: T2
    Definition Classes
    IdentityPair → Product2
  3. def canEqual(other: Any): Boolean
    Definition Classes
    IdentityPair → Equals
  4. def equals(other: Any): Boolean
    Definition Classes
    IdentityPair → Equals → AnyRef → Any
  5. def hashCode(): Int
    Definition Classes
    IdentityPair → AnyRef → Any
  6. def productArity: Int
    Definition Classes
    Product2 → Product
  7. def productElement(n: Int): Any
    Definition Classes
    Product2 → Product
    Annotations
    @throws(classOf[java.lang.IndexOutOfBoundsException])
  8. def productElementNames: Iterator[String]
    Definition Classes
    Product