Trait

org.opalj.hermes

FeatureQuery

Related Doc: package hermes

Permalink

trait FeatureQuery extends AnyRef

Extracts a feature/a set of closely related features of a given project.

Linear Supertypes
AnyRef, Any
Known Subclasses
APIFeatureQuery, BytecodeInstructions, BytecodeInstrumentationAPIUsage, ClassFileVersion, ClassLoaderAPIUsage, ClassTypes, DebugInformation, DefaultFeatureQuery, DefaultGroupedFeaturesQuery, FanInFanOut, FieldAccessStatistics, GUIAPIUsage, JDBCAPIUsage, JavaCryptoArchitectureUsage, MethodTypes, MethodsWithoutReturns, Metrics, RecursiveDataStructures, ReflectionAPIUsage, SizeOfInheritanceTree, SystemAPIUsage, ThreadAPIUsage, TrivialReflectionUsage, UnsafeAPIUsage
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FeatureQuery
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def apply[S](projectConfiguration: ProjectConfiguration, project: Project[S], rawClassFiles: Traversable[(ClassFile, S)]): TraversableOnce[Feature[S]]

    Permalink

    The function which analyzes the project and extracts the feature information.

    The function which analyzes the project and extracts the feature information.

    project

    A representation of the project. To speed up queries, intermediate information that may also be required by other queries can/should be stored in the project using the org.opalj.fpcf.PropertyStore or using a org.opalj.br.analyses.ProjectInformationKey.

    rawClassFiles

    A direct 1:1 representation of the class files. This makes it possible to write queries that need to get an understanding of an unprocessed class file; e.g. that need to analyze the constant pool in detail.

    Note

    Every query should regularly check that its thread is not interrupted using isInterrupted.

  2. abstract def featureIDs: Seq[String]

    Permalink

    The unique ids of the extracted features.

Concrete 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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. val htmlDescription: Either[String, URL]

    Permalink

    Returns an HTML description of this feature query that is targeted at end users; by default it calls mdDescription to try to find a markdown document that describes this feature and then uses TxtMark to convert the document.

    Returns an HTML description of this feature query that is targeted at end users; by default it calls mdDescription to try to find a markdown document that describes this feature and then uses TxtMark to convert the document. If a document is returned the web engine's user style sheet is set to org.opalj.hermes.FeatureQueries.MDCSS; in case of an URL no stylesheet is set.

    returns

    An HTML document/a link to an HTML document that describes this query.

  12. val id: String

    Permalink

    A short descriptive name; by default the simple name of this class.

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  14. final def isInterrupted(): Boolean

    Permalink

    Queries should regularly check if they are interrupted using this method.

  15. def mdDescription: String

    Permalink

    Returns an explanation of the feature (group) using Markdown as its formatting language.

    Returns an explanation of the feature (group) using Markdown as its formatting language.

    By default the name of the class is used to lookup the resource "className.markdown" which is expected to be found along the extractor.

    Attributes
    protected

  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  21. final def wait(): Unit

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

  22. final def wait(arg0: Long, arg1: Int): Unit

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

  23. final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped