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 av

  Definition Classes

  opalj

•  package checking

  Helper classes and functionality related to specifying architectural concerns.

  Helper classes and functionality related to specifying architectural concerns.

  Definition Classes

  av

•  class Specification extends AnyRef

  A specification of a project's architectural constraints.

  A specification of a project's architectural constraints.

  Usage

  First define the ensembles, then the rules and at last specify the class files that should be analyzed. The rules will then automatically be evaluated.

  The intended way to create a specification is to create a new anonymous Specification class that contains the specification of the architecture. Afterwards the specification object can be used to get the list of architectural violations.

  new Specification(project) {
             ensemble('Number) { "mathematics.Number*" }
             ensemble('Rational) { "mathematics.Rational*" }
             ensemble('Mathematics) { "mathematics.Mathematics*" }
             ensemble('Example) { "mathematics.Example*" }
  
             'Example is_only_allowed_to (USE, 'Mathematics)
        }

  Note

  One ensemble is predefined: Specification.empty it represents an ensemble that contains no source elements and which can, e.g., be used to specify that no "real" ensemble is allowed to depend on a specific ensemble.

  Definition Classes

  checking

• GlobalIncomingConstraint
• LocalOutgoingAnnotatedWithConstraint
• LocalOutgoingNotAllowedConstraint
• LocalOutgoingOnlyAllowedConstraint
• LocalOutgoingShouldExtendConstraint
• LocalOutgoingShouldImplementMethodConstraint
• SpecificationFactory

org.opalj.av.checking.Specification

SpecificationFactory