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 - org.opalj.bi) that can be used to create arbitrary representations.
    • a library to create a one-to-one in-memory representation of Java bytecode (Bytecode Disassembler - org.opalj.da).
    • a library to convert this representation to Java class files (Bytecode Creator - org.opalj.bc).
    • a library to create a representation of Java bytecode that facilitates writing simple static analyses (Bytecode Representation - org.opalj.br).
    • a library to create a stackless, three-address code representation of Java bytecode that facilitates writing complex static analyses (Three Address Code - org.opalj.tac).
    • 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 (Dependencies Extraction - org.opalj.de) and to facilitate checking architecture definitions (Architecture Validation - org.opalj.av).
    • a library for the lightweight manipulation and creation of Java bytecode (Bytecode Assembler - org.opalj.ba).
    • a library for parsing Android packages (APK - org.opalj.apk).
    • libraries for writing static analyses using the interprocedural finite distributive subset (IFDS - org.opalj.ifds) and interprocedural distributive environment (IDE - org.opal.ide) algorithms.

    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 simple Scala based analyses. This representation is engineered such that it facilitates writing analyses that use pattern matching.

    Definition Classes
    opalj
  • package analyses

    Defines commonly useful type aliases.

    Defines commonly useful type aliases.

    Definition Classes
    br
  • package cg
    Definition Classes
    analyses
  • AbstractClassExtensibility
  • AllEntryPointsFinder
  • AllInstantiatedTypesFinder
  • AllPackagesClosed
  • ApplicationEntryPointsFinder
  • ApplicationInstantiatedTypesFinder
  • ApplicationWithoutJREEntryPointsFinder
  • CallBySignatureKey
  • CallBySignatureTargets
  • ClassExtensibility
  • ClassExtensibilityKey
  • ClassHierarchyIsNotExtensible
  • ClosedPackages
  • ClosedPackagesConfiguration
  • ClosedPackagesKey
  • ConfigurationEntryPointsFinder
  • ConfigurationInstantiatedTypesFinder
  • ConfiguredExtensibleClasses
  • ConfiguredFinalClasses
  • DefaultClassExtensibility
  • EntryPointFinder
  • InitialEntryPointsKey
  • InitialInstantiatedTypesKey
  • InstantiatedTypesFinder
  • IsOverridableMethodKey
  • LibraryEntryPointsFinder
  • LibraryInstantiatedTypesFinder
  • MetaEntryPointsFinder
  • OpenCodeBase
  • TypeExtensibilityAnalysis
  • TypeExtensibilityKey

trait ConfigurationEntryPointsFinder extends EntryPointFinder

This trait provides an analysis that loads entry points from the project configuration file.

All entry points must be configured under the following configuration key: **org.opalj.br.analyses.cg.InitialEntryPointsKey.entryPoints**

Example:

org.opalj.br.analyses.cg {
    InitialEntryPointKey {
        analysis = "org.opalj.br.analyses.cg.ConfigurationEntryPointsFinder"
        entryPoints = [
          {declaringClass = "java/util/List+", name = "add"},
          {declaringClass = "java/util/List", name = "remove", descriptor = "(I)Z"}
        ]
    }
}

Please note that the first entry point, by adding the "+" to the declaring class' name, considers all "add" methods from all subtypes independently from the respective method's descriptor. In contrast, the second entry does specify a descriptor and does not consider List's subtypes (by not suffixing a plus to the declaringClass) which implies that only the remove method with this descriptor is considered as entry point.

Source
EntryPointFinder.scala
Linear Supertypes
EntryPointFinder, AnyRef, Any
Known Subclasses
ApplicationEntryPointsFinder, ApplicationWithoutJREEntryPointsFinder, ConfigurationEntryPointsFinder, LibraryEntryPointsFinder, MetaEntryPointsFinder
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigurationEntryPointsFinder
  2. EntryPointFinder
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. def collectEntryPoints(project: SomeProject): Iterable[DeclaredMethod]

    Returns the set of entry points for a given project under analysis.

    Returns the set of entry points for a given project under analysis. Entry points may be virtual, if they are defined by the configuration but not contained in the project.

    project

    The concrete project for which to compute entry points

    returns

    Set of entry points to the project

    Definition Classes
    ConfigurationEntryPointsFinder → EntryPointFinder
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. def requirements(project: SomeProject): ProjectInformationKeys

    Returns ProjectInformationKeys required by this EntryPointFinder If no extra keys are required, Nil can be returned.

    Returns ProjectInformationKeys required by this EntryPointFinder If no extra keys are required, Nil can be returned.

    project

    The concrete project for which to compute requirements

    returns

    The set of required project information key

    Definition Classes
    EntryPointFinder
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from EntryPointFinder

Inherited from AnyRef

Inherited from Any

Ungrouped