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 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
o

org.opalj.br.analyses.cg

InitialEntryPointsKey

object InitialEntryPointsKey extends ProjectInformationKey[Iterable[Method], Nothing]

The key object to get a traversable of entry points. Entry points are particularly relevant to construct call graphs. See InitialEntryPointsKey for further details.

This key reflectively instantiates the analysis that determines the program's entry points. The respective analysis has to extend the trait InitialEntryPointsKey class.

To configure which analysis is used use the key org.opalj.br.analyses.cg.InitialEntryPointKey.analysis to specify the name of the class which implements the analysis.

Source
InitialEntryPointsKey.scala
Example:

  1. org.opalj.br.analyses.cg {
    InitialEntryPointKey {
        analysis = "org.opalj.br.analyses.cg.ApplicationEntryPointFinder"
    }
}
Note

Please see the documentation of EntryPointFinder and its subtypes for more information.

Linear Supertypes
ProjectInformationKey[Iterable[Method], Nothing], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InitialEntryPointsKey
  2. ProjectInformationKey
  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 val ConfigKey: String("org.opalj.br.analyses.cg.InitialEntryPointsKey.analysis")
  5. final val ConfigKeyPrefix: String("org.opalj.br.analyses.cg.InitialEntryPointsKey.")
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. def compute(project: SomeProject): Iterable[Method]

    Reflectively instantiates a ClosedPackagesAnalysis for the given project.

    Reflectively instantiates a ClosedPackagesAnalysis for the given project. The instantiated class has to satisfy the interface and needs to provide a single constructor parameterized over a Project.

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

    The InitialEntryPointsKey depends on three other keys and queries information about closed packages, must answer the question whether a method can be overridden by unknown code, and performs checks whether types are extensible or not.

    The InitialEntryPointsKey depends on three other keys and queries information about closed packages, must answer the question whether a method can be overridden by unknown code, and performs checks whether types are extensible or not.

    returns

    Nil.

    Definition Classes
    InitialEntryPointsKey → ProjectInformationKey
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final val uniqueId: Int

    The unique id of this key.

    The unique id of this key. The key is used to enable efficient access and is automatically assigned by OPAL and will not change after that.

    Definition Classes
    ProjectInformationKey
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. 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

Inherited from ProjectInformationKey[Iterable[Method], Nothing]

Inherited from AnyRef

Inherited from Any

Ungrouped