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
  • Analysis
  • AnalysisApplication
  • AnalysisException
  • BasicMethodInfo
  • BasicReport
  • DeclaredMethods
  • DeclaredMethodsKey
  • FieldAccessInformation
  • FieldAccessInformationAnalysis
  • FieldAccessInformationKey
  • InconsistentProjectException
  • JavaProject
  • MethodAnalysisApplication
  • MethodDeclarationContext
  • MethodDeclarationContextOrdering
  • MethodInfo
  • ModuleDefinition
  • OneStepAnalysis
  • ProgressEvents
  • ProgressManagement
  • Project
  • ProjectAnalysisApplication
  • ProjectBasedAnalysis
  • ProjectIndex
  • ProjectIndexKey
  • ProjectInformationKey
  • ProjectLike
  • ReportableAnalysisResult
  • StringConstantsInformationKey
  • VirtualFormalParameter
  • VirtualFormalParameters
  • VirtualFormalParametersKey

object Project

Definition of factory methods to create Projects.

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

Type Members

  1. type HandleInconsistentProject = (LogContext, InconsistentProjectException) => Unit

    The type of the function that is called if an inconsistent project is detected.

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. def JavaClassFileReader(implicit theLogContext: LogContext = GlobalLogContext, theConfig: Config = BaseConfig): Java17FrameworkWithDynamicRewritingAndCaching
  5. lazy val JavaLibraryClassFileReader: Java17LibraryFramework.type
  6. def apply[Source](projectClassFilesWithSources: Iterable[(ClassFile, Source)], libraryClassFilesWithSources: Iterable[(ClassFile, Source)], libraryClassFilesAreInterfacesOnly: Boolean, virtualClassFiles: Iterable[ClassFile], handleInconsistentProject: HandleInconsistentProject, config: Config, logContext: LogContext): Project[Source]
  7. def apply[Source](projectClassFilesWithSources: Iterable[(ClassFile, Source)], libraryClassFilesWithSources: Iterable[(ClassFile, Source)], libraryClassFilesAreInterfacesOnly: Boolean, virtualClassFiles: Iterable[ClassFile] = Iterable.empty, handleInconsistentProject: HandleInconsistentProject = defaultHandlerForInconsistentProjects)(implicit config: Config = BaseConfig, projectLogger: OPALLogger = OPALLogger.globalLogger()): Project[Source]

    Creates a new Project.

    Creates a new Project.

    projectClassFilesWithSources

    The list of class files of this project that are considered to belong to the application/library that will be analyzed. [Thread Safety] The underlying data structure has to support concurrent access.

    libraryClassFilesWithSources

    The list of class files of this project that make up the libraries used by the project that will be analyzed. [Thread Safety] The underlying data structure has to support concurrent access.

    libraryClassFilesAreInterfacesOnly

    If true then only the non-private interface of of the classes belonging to the library was loaded. I.e., this setting just reflects the way how the class files were loaded; it does not change the classes!

    virtualClassFiles

    A list of virtual class files that have no direct representation in the project. Such declarations are created, e.g., to handle invokedynamic instructions. In general, such class files should be added using projectClassFilesWithSources and the Source should be the file that was the reason for the creation of this additional ClassFile. [Thread Safety] The underlying data structure has to support concurrent access.

    handleInconsistentProject

    A function that is called back if the project is not consistent. The default behavior (defaultHandlerForInconsistentProjects) is to write a warning message to the console. Alternatively it is possible to throw the given exception to cancel the loading of the project (which is the only meaningful option for several advanced analyses.)

  8. def apply[Source](projectClassFilesWithSources: Iterable[(ClassFile, Source)], libraryClassFilesWithSources: Iterable[(ClassFile, Source)], libraryClassFilesAreInterfacesOnly: Boolean): Project[Source]
  9. def apply(projectFiles: Array[File], libraryFiles: Array[File]): Project[URL]
  10. def apply(projectFile: File, libraryFile: File): Project[URL]
  11. def apply[Source](projectClassFilesWithSources: Iterable[(ClassFile, Source)], projectLogger: OPALLogger): Project[Source]
  12. def apply[Source](projectClassFilesWithSources: Iterable[(ClassFile, Source)]): Project[Source]
  13. def apply(projectFiles: Array[File], libraryFiles: Array[File], logContext: LogContext, config: Config): Project[URL]
  14. def apply(file: File, logContext: LogContext, config: Config): Project[URL]
  15. def apply(file: File, projectLogger: OPALLogger): Project[URL]
  16. def apply(file: File): Project[URL]

    Given a reference to a class file, jar file or a folder containing jar and class files, all class files will be loaded and a project will be returned.

    Given a reference to a class file, jar file or a folder containing jar and class files, all class files will be loaded and a project will be returned.

    The global logger will be used for logging messages.

  17. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  19. def defaultHandlerForInconsistentProjects(logContext: LogContext, ex: InconsistentProjectException): Unit

    This default handler just "logs" inconsistent project exceptions at the org.opalj.log.Warn level.

  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. def extend[Source](project: Project[Source], projectClassFilesWithSources: Iterable[(ClassFile, Source)]): Project[Source]

    Creates a new Project that consists of the class files of the previous project and the newly given class files.

  23. def extend(project: Project[URL], file: File): Project[URL]
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  26. def instanceMethods(classHierarchy: ClassHierarchy, objectTypeToClassFile: (ObjectType) => Option[ClassFile])(implicit logContext: LogContext): Map[ObjectType, ArraySeq[MethodDeclarationContext]]
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. def overridingMethods(classHierarchy: ClassHierarchy, virtualMethodsCount: Int, objectTypeToClassFile: Map[ObjectType, ClassFile])(implicit theLogContext: LogContext): Map[Method, Set[Method]]

    Returns for a given virtual method the set of all non-abstract virtual methods which override it.

    Returns for a given virtual method the set of all non-abstract virtual methods which override it.

    This method takes the visibility of the methods and the defining context into consideration.

    Note

    The map only contains those methods which have at least one concrete implementation.

    See also

    Method.isVirtualMethodDeclaration for further details.

  32. def recreate[Source](project: Project[Source], config: Config = ConfigFactory.empty(), useOldConfigAsFallback: Boolean = true): Project[Source]

    Creates a new Project that consists of the source files of the previous project and uses the (new) configuration.

    Creates a new Project that consists of the source files of the previous project and uses the (new) configuration. The old project configuration is — by default – used as a fallback, so not all values have to be updated.

    If you just want to clear the derived data, using Project.recreate is more efficient.

  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. 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 AnyRef

Inherited from Any

Ungrouped