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
  • AccessFlags
  • AllClasses
  • AnnotatedWith
  • AnnotationPredicate
  • AnnotationsPredicate
  • AnyAnnotation
  • AnyAnnotations
  • AnyMethod
  • ArchitectureChecker
  • Attributes
  • BinaryString
  • ClassLevelMatcher
  • ClassMatcher
  • DefaultClassMatcher
  • DependencyChecker
  • DependencyViolation
  • Equals
  • FieldMatcher
  • HasAnnotation
  • HasAtLeastOneAnnotation
  • HasAtLeastTheAnnotations
  • HasTheAnnotations
  • MethodMatcher
  • MethodWithName
  • MethodWithSignature
  • NamePredicate
  • NoAnnotations
  • NoSourceElementsMatcher
  • PackageMatcher
  • PropertyChecker
  • PropertyViolation
  • RegexNamePredicate
  • SourceElementPredicate
  • SourceElementsMatcher
  • Specification
  • SpecificationError
  • SpecificationViolation
  • StartsWith

case class AnnotatedWith(annotationType: FieldType, elementValuePairs: Seq[ElementValuePair]) extends AnnotationPredicate with Product with Serializable

Tests if an annotation of a class, field, method or method parameter is as specified. The test takes the element values into consideration; if you don't want to take them into consideration use a HasAnnotation predicate.

scala> import org.opalj.br._
scala> import org.opalj.av.checking._
scala> val foo = ObjectType("java/lang/Foo")

scala> val am = AnnotationPredicate("java.lang.Foo",Map("clazz" -> StringValue("")))
am: org.opalj.av.checking.AnnotationPredicate = @java.lang.Foo(clazz="")

scala> am(Annotation(foo,IndexedSeq(ElementValuePair("clazz",StringValue("")))))
res: Boolean = true

scala> am(Annotation(foo,IndexedSeq(ElementValuePair("clazz",StringValue("-+-")))))
res: Boolean = false

scala> val am = DefaultAnnotationPredicate("java.lang.Foo",IndexedSeq.empty)
am: org.opalj.av.checking.DefaultAnnotationPredicate = @java.lang.Foo()

scala> am(Annotation(ObjectType("java/lang/Foo"),IndexedSeq(ElementValuePair("clazz",StringValue(" ")))))
res: Boolean = false
Source
AnnotationPredicate.scala
Linear Supertypes
Serializable, Product, scala.Equals, AnnotationPredicate, SourceElementPredicate[ConcreteSourceElement], (ConcreteSourceElement) => Boolean, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AnnotatedWith
  2. Serializable
  3. Product
  4. Equals
  5. AnnotationPredicate
  6. SourceElementPredicate
  7. Function1
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AnnotatedWith(annotationType: FieldType, elementValuePairs: Seq[ElementValuePair])

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 and[T <: ConcreteSourceElement, X <: ConcreteSourceElement with T](right: SourceElementPredicate[T]): SourceElementPredicate[X]
    Definition Classes
    SourceElementPredicate
  5. def andThen[A](g: (Boolean) => A): (ConcreteSourceElement) => A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  6. val annotationType: FieldType
  7. def apply(sourceElement: ConcreteSourceElement): Boolean
    Definition Classes
    AnnotatedWith → Function1
  8. def apply(that: Annotation): Boolean

    Checks if the given annotation is as specified by this predicate.

    Checks if the given annotation is as specified by this predicate. Returns true if the given annotation has the type annotationTypeand if all element value pairs are matched independent of their order.

    Example Scenarios

    • If the predicate's annotation type is A and the other annotation's type is B then the elements will not match.
    • If the predicate defines specific org.opalj.br.ElementValuePairs such as ArrayBuffer(ElementValuePair("target", ClassValue("org.opalj.av.checking.AnnotationPredicate")), ElementValuePair("name", StringValue("Annotation_Predicate")) it will then match annotations where the org.opalj.br.ElementValuePairs have a different order: ArrayBuffer(ElementValuePair("name", StringValue("Annotation_Predicate"), ElementValuePair("target", ClassValue("org.opalj.av.checking.AnnotationPredicate"))) But it will not match if one or both of the two org.opalj.br.ElementValuePairs are missing or there is another org.opalj.br.ElementValuePair not defined by this predicate.
    Definition Classes
    AnnotatedWith → AnnotationPredicate
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  11. def compose[A](g: (A) => ConcreteSourceElement): (A) => Boolean
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  12. val elementValuePairs: Seq[ElementValuePair]
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. final def having[T <: ConcreteSourceElement, X <: ConcreteSourceElement with T](right: SourceElementPredicate[T]): SourceElementPredicate[X]
    Definition Classes
    SourceElementPredicate
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toDescription(): String

    Returns a human readable representation of this predicate that is well suited for presenting it in messages related to architectural deviations.

    Returns a human readable representation of this predicate that is well suited for presenting it in messages related to architectural deviations.

    It should not end with a white space and should not use multiple lines. It should not be a complete sentence as this description may be composed with other descriptions.

    Definition Classes
    AnnotatedWith → AnnotationPredicate → SourceElementPredicate
  23. def toString(): String
    Definition Classes
    Function1 → AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. 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 AnnotationPredicate

Inherited from SourceElementPredicate[ConcreteSourceElement]

Inherited from (ConcreteSourceElement) => Boolean

Inherited from AnyRef

Inherited from Any

Ungrouped