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 av
    Definition Classes
    opalj
  • package checking

    Helper classes and functionality related to specifying architectural concerns.

    Helper classes and functionality related to specifying architectural concerns.

    Definition Classes
    av
  • class Specification extends AnyRef

    A specification of a project's architectural constraints.

    A specification of a project's architectural constraints.

    Usage

    First define the ensembles, then the rules and at last specify the class files that should be analyzed. The rules will then automatically be evaluated.

    The intended way to create a specification is to create a new anonymous Specification class that contains the specification of the architecture. Afterwards the specification object can be used to get the list of architectural violations.

    new Specification(project) {
               ensemble('Number) { "mathematics.Number*" }
               ensemble('Rational) { "mathematics.Rational*" }
               ensemble('Mathematics) { "mathematics.Mathematics*" }
               ensemble('Example) { "mathematics.Example*" }
    
               'Example is_only_allowed_to (USE, 'Mathematics)
          }
    Note

    One ensemble is predefined: Specification.empty it represents an ensemble that contains no source elements and which can, e.g., be used to specify that no "real" ensemble is allowed to depend on a specific ensemble.

    Definition Classes
    checking
  • GlobalIncomingConstraint
  • LocalOutgoingAnnotatedWithConstraint
  • LocalOutgoingNotAllowedConstraint
  • LocalOutgoingOnlyAllowedConstraint
  • LocalOutgoingShouldExtendConstraint
  • LocalOutgoingShouldImplementMethodConstraint
  • SpecificationFactory
c

org.opalj.av.checking.Specification

LocalOutgoingAnnotatedWithConstraint

case class LocalOutgoingAnnotatedWithConstraint(sourceEnsemble: Symbol, annotationPredicates: Seq[AnnotationPredicate], property: String, matchAny: Boolean) extends PropertyChecker with Product with Serializable

Checks whether all elements in the source ensemble are annotated with the given annotation.

Example Scenario

If every element in the ensemble ex should be annotated with ey and the source element x which belongs to ensemble ex has no annotation that matches ey then a SpecificationViolation is generated.

sourceEnsemble

An ensemble containing elements, that should be annotated.

annotationPredicates

The annotations that should match.

property

A description of the property that is checked.

matchAny

true if only one match is needed, false if all annotations should match

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

Instance Constructors

  1. new LocalOutgoingAnnotatedWithConstraint(sourceEnsemble: Symbol, annotationPredicates: Seq[AnnotationPredicate], matchAny: Boolean = false)
  2. new LocalOutgoingAnnotatedWithConstraint(sourceEnsemble: Symbol, annotationPredicates: Seq[AnnotationPredicate], property: String, matchAny: Boolean)

    sourceEnsemble

    An ensemble containing elements, that should be annotated.

    annotationPredicates

    The annotations that should match.

    property

    A description of the property that is checked.

    matchAny

    true if only one match is needed, false if all annotations should match

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. val annotationPredicates: Seq[AnnotationPredicate]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. def ensembles: Seq[Symbol]
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. val matchAny: Boolean
  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 productElementNames: Iterator[String]
    Definition Classes
    Product
  16. val property: String

    A textual representation of the property.

    A textual representation of the property.

    Definition Classes
    LocalOutgoingAnnotatedWithConstraintPropertyChecker
  17. val sourceEnsemble: Symbol
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    LocalOutgoingAnnotatedWithConstraint → AnyRef → Any
  20. def violations(): Set[SpecificationViolation]
  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 Serializable

Inherited from Product

Inherited from scala.Equals

Inherited from PropertyChecker

Inherited from ArchitectureChecker

Inherited from AnyRef

Inherited from Any

Ungrouped