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

case class DocumentationComment(label: String, brief: String, description: Seq[String], datatype: String, constraints: Seq[String]) extends Product with Serializable

Container for the comments of a config node.

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

Instance Constructors

  1. new DocumentationComment(label: String, brief: String, description: Seq[String], datatype: String, constraints: Seq[String])

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. val brief: String
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. val constraints: Seq[String]
  8. val datatype: String
  9. val description: Seq[String]
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def getBrief(exporter: HTMLExporter): String

    Method used for fetching information of the brief field.

    Method used for fetching information of the brief field.

    returns

    Returns the brief field of the DocumentationComment if it exists. If it does not exist, it returns a preview of the description.

  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def isEmpty: Boolean

    Checks if the comment is empty.

    Checks if the comment is empty.

    returns

    returns true if the comment is empty but the label property (the label property is set automatically for config files.).

  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. val label: String
  16. def mergeComment(comment: DocumentationComment): DocumentationComment

    Merges another comment into this comment.

    Merges another comment into this comment. The datatype flag will not be merged. Reason for this is that datatypes are only used to describe entries, which cannot be merged anyways.

    comment

    accepts the comment that should be merged into this comment.

    returns

    returns a merged DocumentationComment.

  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def needsDetails(maxLength: Int): Boolean
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. def replaceClasses(se: SubclassExtractor): DocumentationComment

    This method is responsible for finding all subclasses to a subclass type and adds them to the constraints.

    This method is responsible for finding all subclasses to a subclass type and adds them to the constraints.

    se

    Accepts an initialized subclass extractor. It accesses the ClassHierarchy that was extracted by the subclass extractor and finds its subclasses within the structure.

    returns

    Returns an Updated DocumentationComment if there were classes to replace. Returns itself otherwise.

  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toHTML(pageHTML: StringBuilder): Unit

    Converts the Comment object into HTML syntax.

    Converts the Comment object into HTML syntax.

    pageHTML

    The method will add the export to this StringBuilder.

  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 AnyRef

Inherited from Any

Ungrouped