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 eval
  • package immutable
  • package mutable
  • BitSet
  • CompleteCollection
  • EqualSets
  • ForeachRefIterator
  • IncompleteCollection
  • IntCollectionWithStableOrdering
  • IntIterator
  • IntSet
  • LongCollectionWithStableOrdering
  • LongIterator
  • LongSet
  • QualifiedCollection
  • RefIndexedView
  • SetRelation
  • SingletonSet
  • StrictSubset
  • StrictSuperset
  • UID
  • UIDValue
  • UncomparableSets
  • package concurrent

    Common constants, factory methods and objects used throughout OPAL when performing concurrent computations.

    Common constants, factory methods and objects used throughout OPAL when performing concurrent computations.

    Definition Classes
    opalj
  • package constraints

    Defines helper values and methods related to modeling constraints.

    Defines helper values and methods related to modeling constraints.

    Definition Classes
    opalj
  • package control

    Defines common control abstractions.

    Defines common control abstractions.

    Definition Classes
    opalj
  • package graphs

    This package defines graph algorithms as well as factory methods to describe and compute graphs and trees.

    This package defines graph algorithms as well as factory methods to describe and compute graphs and trees.

    This package supports the following types of graphs:

    1. graphs based on explicitly connected nodes (org.opalj.graphs.Node),
    2. graphs where the relationship between the nodes are encoded externally (org.opalj.graphs.Graph).
    Definition Classes
    opalj
  • package io

    Various io-related helper methods and classes.

    Various io-related helper methods and classes.

    Definition Classes
    opalj
    Note

    The implementations of the methods rely on Java NIO(2).

  • package log
    Definition Classes
    opalj
  • package util

    Utility methods.

    Utility methods.

    Definition Classes
    opalj
p

org.opalj

collection

package collection

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.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. collection
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package eval
  2. package immutable
  3. package mutable

Type Members

  1. trait BitSet extends AnyRef

    Common interface of all BitSet based collections provided by OPAL.

  2. case class CompleteCollection[+S](s: S) extends QualifiedCollection[S] with Product with Serializable
  3. abstract class ForeachRefIterator[+T] extends AnyRef

    Specialized variant of an internal iterator.

    Specialized variant of an internal iterator. The only way to iterate over a foreach iterator is to use foreach. Compared to a classical iterator, iteration can be repeated and more efficient implementation strategies are easily possible.

    Note

    The type bound T <: AnyRef is expected to be ex-/implicitly enforced by subclasses.

  4. case class IncompleteCollection[+S](s: S) extends QualifiedCollection[S] with Product with Serializable
  5. trait IntCollectionWithStableOrdering[T <: IntSet[T]] extends AnyRef

    Can be mixed in if the iteration order is always that same independent of the insertion order.

    Can be mixed in if the iteration order is always that same independent of the insertion order. This is typically the case if the values are (pseudo-)sorted.

  6. abstract class IntIterator extends AbstractIterator[Int]

    Iterator over a collection of primitive int valuea; basically overrides all inherited methods to avoid (un)boxing.

    Iterator over a collection of primitive int valuea; basically overrides all inherited methods to avoid (un)boxing.

    Note

    No guarantee is given what will happen if next is called after hasNext returns or would have returned false.

  7. trait IntSet[T <: IntSet[T]] extends AnyRef

    A set of integer values.

  8. trait LongCollectionWithStableOrdering[T <: LongCollectionWithStableOrdering[T]] extends AnyRef

    Can be mixed in if the iteration order is always that same independent of the insertion order.

    Can be mixed in if the iteration order is always that same independent of the insertion order. This is typically the case if the values are (pseudo-)sorted.

  9. abstract class LongIterator extends AbstractIterator[Long]

    Iterator over a collection of longs; basically all methods are overridden to avoid (un)boxing operations.

  10. trait LongSet extends AnyRef

    A set of long values.

  11. sealed trait QualifiedCollection[+S] extends AnyRef

    Identifies a collection as being (guaranteed) complete or as being potentially incomplete.

    Identifies a collection as being (guaranteed) complete or as being potentially incomplete.

    This class is typically used by analyses that derive some results and which are also able to do so of in cases incomplete information. But in latter cases the analyses may not be able to determine whether the derived information is complete or not. For example, imagine you are analyzing some library (but not the JDK). In this case the class hierarchy will be incomplete and every analysis using it may compute incomplete information.

  12. trait RefIndexedView[+T] extends AnyRef

    Defines a view on some indexed data structure.

    Defines a view on some indexed data structure.

    Note

    The type bound T <: AnyRef has to be ex-/implicitly enforced by subclasses.

  13. sealed abstract class SetRelation extends AnyRef

    Describes the relation between two sets.

  14. type SomeIntSet = IntSet[_]
  15. trait UID extends AnyRef

    Identifies objects which have - in the scope where the objects are used - unique ids.

    Identifies objects which have - in the scope where the objects are used - unique ids. I.e., this trait is implemented by objects that have – by construction - unique ids in a well-defined scope. The UIDSet is based on comparing uids.

  16. trait UIDValue extends UID

    Identifies objects which have a – potentially context dependent – unique id.

    Identifies objects which have a – potentially context dependent – unique id. I.e., this trait is implemented by objects that have – by construction - unique ids in a well-defined scope.

    Note

    Two objects that are not equal may still have the same id, if both objects are guaranteed to never be compared against each other.

Value Members

  1. def asScala[K, SubK, V](map: ConcurrentHashMap[K, ConcurrentHashMap[SubK, V]]): Map[K, Map[SubK, V]]

    Converts a multi-map (a Map that contains Maps) based on java.util.concurrent.ConcurrentHashMaps into a corresponding multi-map based on scala.collection.immutable.HashMaps.

    Converts a multi-map (a Map that contains Maps) based on java.util.concurrent.ConcurrentHashMaps into a corresponding multi-map based on scala.collection.immutable.HashMaps. E.g.,

    val source : ConcurrentHashMap[SourceElement, CMap[ArrayType, Set[DType]]] =...
val target : Map[SourceElement, Map[ArrayType, Set[DType]]] = asScala(source)
  2. def binarySearch[T, X >: T <: Comparable[X]](array: ArraySeq[T], key: X): Int
  3. def commonPrefix[T](l1: List[T], l2: List[T]): List[T]

    Returns the common prefix of the given lists.

    Returns the common prefix of the given lists. If l1 is a prefix of l2, then l1 is returned. If l2 is a prefix of l1, l2 is returned, otherwise a new list that contains the prefix is returned. Hence, if l1===l2 then l1 is returned.

  4. def insertedAt[T, X >: T <: AnyRef](array: ArraySeq[T], insertionPoint: Int, e: X): ArraySeq[X]
  5. object EqualSets extends SetRelation
  6. object ForeachRefIterator
  7. object IntIterator
  8. object LongIterator
  9. object LongSet

    Defines convenience functions and data-structures used by OPAL's data-structures.

  10. object RefIndexedView
  11. object SingletonSet

    Facilitates the matching of a Scala collection Set that contains a single value.

  12. object StrictSubset extends SetRelation
  13. object StrictSuperset extends SetRelation
  14. object UID

    Helper methods related to data structures that have unique ids.

  15. object UncomparableSets extends SetRelation

Inherited from AnyRef

Inherited from Any

Ungrouped