Class/Object

org.opalj.av.checking

Specification

Related Docs: object Specification | package checking

Permalink

class Specification extends AnyRef

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.

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

Instance Constructors

  1. new Specification(classFiles: Traversable[(ClassFile, URL)], useAnsiColors: Boolean = false)

    Permalink
  2. new Specification(project: Project[URL])

    Permalink

    Creates a new Specification for the given Project.

    Creates a new Specification for the given Project. Error messages will not use ANSI colors.

  3. new Specification(project: Project[URL], useAnsiColors: Boolean)

    Permalink

Type Members

  1. case class GlobalIncomingConstraint(targetEnsemble: Symbol, sourceEnsembles: Seq[Symbol]) extends DependencyChecker with Product with Serializable

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

    Permalink

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

    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

  3. case class LocalOutgoingNotAllowedConstraint(dependencyTypes: Set[DependencyType], sourceEnsemble: Symbol, targetEnsembles: Seq[Symbol]) extends DependencyChecker with Product with Serializable

    Permalink

    Forbids the given local dependencies between a specific source ensemble and several target ensembles.

    Forbids the given local dependencies between a specific source ensemble and several target ensembles.

    Example Scenario

    If the ensemble ex is not allowed to use ey and the source element x which belongs to ensemble ex has one if the given dependencies on a source element belonging to ey then a SpecificationViolation is generated.

  4. case class LocalOutgoingOnlyAllowedConstraint(dependencyTypes: Set[DependencyType], sourceEnsemble: Symbol, targetEnsembles: Seq[Symbol]) extends DependencyChecker with Product with Serializable

    Permalink

    Allows only the given local dependencies between a specific source ensemble and several target ensembles.

    Allows only the given local dependencies between a specific source ensemble and several target ensembles.

    Example Scenario

    If the ensemble ex is only allowed to throw exceptions ey and the source element x which belongs to ensemble ex throws an exception not belonging to ey then a SpecificationViolation is generated.

  5. case class LocalOutgoingShouldExtendConstraint(sourceEnsemble: Symbol, targetEnsembles: Seq[Symbol]) extends PropertyChecker with Product with Serializable

    Permalink

    Checks whether all elements in the source ensemble extends any of the given elements.

    Checks whether all elements in the source ensemble extends any of the given elements. The source ensemble should contain only class elements otherwise a SpecificationError will be thrown.

    sourceEnsemble

    An ensemble containing classes, that should implement the given method.

    targetEnsembles

    Ensembles containing elements, that should be extended by the given classes.

  6. case class LocalOutgoingShouldImplementMethodConstraint(sourceEnsemble: Symbol, methodPredicate: SourceElementPredicate[Method]) extends PropertyChecker with Product with Serializable

    Permalink

    Checks whether all elements in the source ensemble implement the given method.

    Checks whether all elements in the source ensemble implement the given method. The source ensemble should contain only class elements otherwise a SpecificationError will be thrown.

    sourceEnsemble

    An ensemble containing classes, that should implement the given method.

    methodPredicate

    The method to match.

  7. case class SpecificationFactory(contextEnsembleSymbol: Symbol) extends Product with Serializable

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def EnsembleID(ensembleName: String): Symbol

    Permalink

    Creates a Symbol with the given name.

    Creates a Symbol with the given name.

    This method is primarily useful if ensemble names are created programmatically and the code should communicate that the created name identifies an ensemble. E.g., instead of

    for (moduleID <- 1 to 10) Symbol("module"+moduleID)

    it is now possible to write

    for (moduleID <- 1 to 10) EnsembleID("module"+moduleID)

    which better communicates the intention.

  5. implicit def EnsembleSymbolToSpecificationElementFactory(ensembleSymbol: Symbol): SpecificationFactory

    Permalink
    Attributes
    protected
  6. implicit def EnsembleToSourceElementMatcher(ensembleSymbol: Symbol): SourceElementsMatcher

    Permalink
    Attributes
    protected
  7. implicit def FileToClassFileProvider(file: File): Seq[(ClassFile, URL)]

    Permalink

    Returns the class files stored at the given location.

  8. implicit def StringToSourceElementMatcher(matcher: String): SourceElementsMatcher

    Permalink

    Facilitates the definition of common source element matchers by means of common String patterns.

    Facilitates the definition of common source element matchers by means of common String patterns.

    Annotations
    @throws( classOf[SpecificationError] )
  9. final val USE: Set[DependencyType]

    Permalink

    The set of all org.opalj.de.DependencyTypes.

  10. def analyze(): Set[SpecificationViolation]

    Permalink
  11. var architectureCheckers: List[ArchitectureChecker]

    Permalink
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. def classes(matcher: Regex): SourceElementsMatcher

    Permalink
  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. val empty: Symbol

    Permalink

    Represents an ensemble that contains no source elements.

    Represents an ensemble that contains no source elements. This can be used, e.g., to specify that a (set of) specific source element(s) is not allowed to depend on any other source elements (belonging to the project).

  16. def ensemble(ensembleSymbol: Symbol)(sourceElementsMatcher: SourceElementsMatcher): Unit

    Permalink

    Adds a new ensemble definition to this architecture specification.

    Adds a new ensemble definition to this architecture specification.

    Annotations
    @throws( classOf[SpecificationError] )
    Exceptions thrown

    SpecificationError If the ensemble is already defined.

  17. def ensembleExtentsToString: String

    Permalink

    Can be called after the evaluation of the extents of the ensembles to print out the current configuration.

  18. def ensembleToString(ensembleSymbol: Symbol): String

    Permalink

    Returns a textual representation of an ensemble.

  19. def ensembles: Map[Symbol, (SourceElementsMatcher, Set[VirtualSourceElement])]

    Permalink

    The set of defined ensembles.

    The set of defined ensembles. An ensemble is identified by a symbol, a query which matches source elements and the project's source elements that are matched. The latter is available only after analyze was called.

  20. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  22. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  24. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  25. def incomingDependencies: Map[VirtualSourceElement, Set[(VirtualSourceElement, DependencyType)]]

    Permalink

    Mapping between a source element and those source elements that depend on it.

    Mapping between a source element and those source elements that depend on it.

    This mapping is automatically created when analyze is called.

  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. def outgoingDependencies: Map[VirtualSourceElement, Map[VirtualSourceElement, DependencyTypesSet]]

    Permalink

    Mapping between a source element and those source elements it depends on/uses.

    Mapping between a source element and those source elements it depends on/uses.

    This mapping is automatically created when analyze is called.

  31. val project: Project[URL]

    Permalink
  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  33. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  34. val useAnsiColors: Boolean

    Permalink
  35. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped