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
  • AccessFlags
  • AllClasses
  • AnnotatedWith
  • AnnotationPredicate
  • AnnotationsPredicate
  • AnyAnnotation
  • AnyAnnotations
  • AnyMethod
  • ArchitectureChecker
  • Attributes
  • BinaryString
  • ClassLevelMatcher
  • ClassMatcher
  • DefaultClassMatcher
  • DependencyChecker
  • DependencyViolation
  • Equals
  • FieldMatcher
  • HasAnnotation
  • HasAtLeastOneAnnotation
  • HasAtLeastTheAnnotations
  • HasTheAnnotations
  • MethodMatcher
  • MethodWithName
  • MethodWithSignature
  • NamePredicate
  • NoAnnotations
  • NoSourceElementsMatcher
  • PackageMatcher
  • PropertyChecker
  • PropertyViolation
  • RegexNamePredicate
  • SourceElementPredicate
  • SourceElementsMatcher
  • Specification
  • SpecificationError
  • SpecificationViolation
  • StartsWith

object Specification

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

Value Members

  1. def Classpath(fileName: String, pathSeparatorChar: Char = java.io.File.pathSeparatorChar): Iterable[String]

    Returns a list of paths contained inside the given classpath file.

    Returns a list of paths contained inside the given classpath file. A classpath file should contain paths as text seperated by a path-separator character. On UNIX systems, this character is ':'; on Microsoft Windows systems it is ';'.

    Example

    /path/to/jar/library.jar:/path/to/library/example.jar:/path/to/library/example2.jar

    Classpath files should be used to prevent absolute paths in tests.

  2. def LibraryJAR(jarName: String): Seq[(ClassFile, URL)]

    Loads all class files of the specified jar file using the library class file reader.

    Loads all class files of the specified jar file using the library class file reader. (I.e., the all method implementations are skipped.)

    jarName

    The name of a jar file.

  3. def LibraryJARs(jarNames: Seq[String]): Seq[(ClassFile, URL)]

    Load all jar files using the library class loader.

  4. def PathToJARs(paths: Iterable[String], jarNames: Iterable[Regex]): Iterable[String]

    Returns a list of paths that match the given list of regular expressions from the given list of paths.

  5. def PathToJARs(paths: Iterable[String], jarName: Regex): Iterable[String]

    Returns a list of paths that matches the given regular expression from the given list of paths.

  6. def ProjectDirectory(directoryName: String): Seq[(ClassFile, URL)]
  7. def ProjectJAR(jarName: String): Seq[(ClassFile, URL)]
  8. def ProjectJARs(jarNames: Seq[String]): Seq[(ClassFile, URL)]

    Load all jar files.