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 ce
    Definition Classes
    opalj
  • CommentParser
  • ConfigEntry
  • ConfigList
  • ConfigNode
  • ConfigObject
  • ConfigurationExplorer
  • DocumentationComment
  • FileLocator
  • HTMLExporter
  • SubclassExtractor
c

org.opalj.ce

ConfigEntry

case class ConfigEntry(value: String, comment: DocumentationComment) extends ConfigNode with Product with Serializable

Stores a value inside the structure of the configNode.

value

is the value stored in the entry.

comment

are all the comments associated with the value.

Source
ConfigEntry.scala
Linear Supertypes
Serializable, Product, Equals, ConfigNode, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigEntry
  2. Serializable
  3. Product
  4. Equals
  5. ConfigNode
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ConfigEntry(value: String, comment: DocumentationComment)

    value

    is the value stored in the entry.

    comment

    are all the comments associated with the value.

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 collapse(): Unit

    Collapse is not needed in config Entry, due to it not having any sub-objects.

    Collapse is not needed in config Entry, due to it not having any sub-objects.

    Definition Classes
    ConfigEntryConfigNode
  7. var comment: DocumentationComment
    Definition Classes
    ConfigEntryConfigNode
  8. def entriesToHTML(exporter: HTMLExporter, pageHTML: StringBuilder)(implicit project: SomeProject): Unit

    Produces the HTML for the individual entries.

    Produces the HTML for the individual entries.

    pageHTML

    accepts a StringBuilder. The method adds the HTML String to this StringBuilder.

    Attributes
    protected
    Definition Classes
    ConfigEntryConfigNode
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def expand(): Unit

    Expand is not needed in config Entry, due to it not having any sub-objects.

    Expand is not needed in config Entry, due to it not having any sub-objects.

    Definition Classes
    ConfigEntryConfigNode
  11. def getBrief(exporter: HTMLExporter)(implicit project: SomeProject): String

    Returns an HMTL-escaped text for the brief description.

    Returns an HMTL-escaped text for the brief description.

    Attributes
    protected
    Definition Classes
    ConfigNode
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def getHeadlineText(label: String): String

    Returns a text for the HTML headline entry.

    Returns a text for the HTML headline entry.

    Attributes
    protected
    Definition Classes
    ConfigNode
  14. def isEmpty: Boolean

    Checks if the value object is empty.

    Checks if the value object is empty.

    returns

    true if both the value and the comment are empty.

    Definition Classes
    ConfigEntryConfigNode
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. def replaceClasses(se: SubclassExtractor): Unit

    Method for replacing a potential subclass type in the comment of the entry.

    Method for replacing a potential subclass type in the comment of the entry.

    se

    Accepts an initialized SubclassExtractor containing the ClassHierarchy required for a successful replacement.

    Definition Classes
    ConfigEntryConfigNode
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toHTML(exporter: HTMLExporter, label: String, pageHTML: StringBuilder)(implicit project: SomeProject): Unit

    Method for handling the export of the configuration structure into an HTML file.

    Method for handling the export of the configuration structure into an HTML file.

    label

    required if the Object is part of another object (Writes the key of the K,V Map there instead). Overrides the label property of the Comment object. Supply an empty string if not needed.

    pageHTML

    accepts a StringBuilder. The method adds the HTML String to this StringBuilder.

    Definition Classes
    ConfigNode
  23. val value: String
  24. def valueToHTML(exporter: HTMLExporter, pageHTML: StringBuilder)(implicit project: SomeProject): Unit
    Definition Classes
    ConfigEntryConfigNode
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from ConfigNode

Inherited from AnyRef

Inherited from Any

Ungrouped