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 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 analyses
    Definition Classes
    fpcf
  • package immutability
    Definition Classes
    analyses
  • ClassImmutabilityAnalysis
  • ClassImmutabilityAnalysisScheduler
  • EagerClassImmutabilityAnalysis
  • EagerTypeImmutabilityAnalysis
  • LazyClassImmutabilityAnalysis
  • LazyTypeImmutabilityAnalysis
  • TypeImmutabilityAnalysis
  • TypeImmutabilityAnalysisScheduler
p

org.opalj.br.fpcf.analyses

immutability

package immutability

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. class ClassImmutabilityAnalysis extends FPCFAnalysis

    Determines the immutability of instances of a specific class.

    Determines the immutability of instances of a specific class. In the case of an abstract class the (implicit) assumption is made that all abstract methods (if any) are/can be implemented without necessarily/always requiring additional state; i.e., only the currently defined fields are taken into consideration. An interfaces is always considered to be transitively immutable. If you need to know if all possible instances of an interface or some type; i.e., all instances of the classes that implement the respective interface/inherit from some class are transitively immutable, you can query the TypeImmutability property.

    In case of incomplete class hierarchies or if the class hierarchy is complete, but some class files are not found the sound approximation is done that the respective classes are mutable.

    This analysis uses the FieldImmutability property to determine the immutability of a class.

    TODO Discuss the case if a constructor calls an instance method which is overrideable (See Verifiable Functional Purity Paper for some arguments.)

  2. trait ClassImmutabilityAnalysisScheduler extends FPCFAnalysisScheduler
  3. class TypeImmutabilityAnalysis extends FPCFAnalysis

    Determines the immutability of a specific type by checking if all subtypes of a specific type are immutable and checking that the set of types is closed.

  4. trait TypeImmutabilityAnalysisScheduler extends FPCFAnalysisScheduler

Value Members

  1. object EagerClassImmutabilityAnalysis extends ClassImmutabilityAnalysisScheduler with FPCFEagerAnalysisScheduler

    Scheduler to run the class immutability analysis eagerly.

  2. object EagerTypeImmutabilityAnalysis extends TypeImmutabilityAnalysisScheduler with BasicFPCFEagerAnalysisScheduler

    Starter for the type immutability analysis.

  3. object LazyClassImmutabilityAnalysis extends ClassImmutabilityAnalysisScheduler with FPCFLazyAnalysisScheduler

    Scheduler to run the class immutability analysis lazily.

  4. object LazyTypeImmutabilityAnalysis extends TypeImmutabilityAnalysisScheduler with BasicFPCFLazyAnalysisScheduler

Ungrouped