InheritableByNewSubtypesAnalysis

This analysis computes the InheritableByNewTypes property.* I.e., it determines whether a method can directly be inherited by a future subtype. This is in particular important when analyzing libraries.

The analysis assumes that packages that start with "java." are closed, i.e., that no client can put a class into these specific packages.

Usage

Use the FPCFAnalysesManagerKey to query the analysis manager of a project. You can run the analysis afterwards as follows:

val analysisManager = project.get(FPCFAnalysisManagerKey)
analysisManager.run(InheritableByNewSubtypesAnalysis)

For detailed information see the documentation of the analysis manager.

The results of this analysis are stored in the property store of the project. You can receive the results as follows:

val thePropertyStore = theProject.get(SourceElementsPropertyStoreKey)
val property = thePropertyStore(method, InheritableByNewTypes.Key)
property match {
  case Some(IsInheritableByNewTypes) => ...
  case Some(NotInheritableByNewTypes) => ...
  case None => ... // this happens only if a not supported entity is passed to the computation.
}

Implementation

This analysis computes the org.opalj.fpcf.properties.InheritableByNewTypes property. Since this makes only sense when libraries are analyzed, using the application mode will result in the org.opalj.fpcf.properties.NotInheritableByNewTypes for every given entity.

This analysis considers all scenarios that are documented by the org.opalj.fpcf.properties.InheritableByNewTypes property.

Note: This analysis implements a direct property computation that is only executed when required.

Linear Supertypes

FPCFAnalysis, AnyRef, Any

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
implicit final val classHierarchy: ClassHierarchy

Definition Classes
FPCFAnalysis
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isClosedLibrary: Boolean

Definition Classes
FPCFAnalysis
final def isDesktopApplication: Boolean

Definition Classes
FPCFAnalysis
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def isJEEApplication: Boolean

Definition Classes
FPCFAnalysis
final def isOpenLibrary: Boolean

Definition Classes
FPCFAnalysis
implicit final val logContext: LogContext

Definition Classes
FPCFAnalysis
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val project: SomeProject

Definition Classes
InheritableByNewSubtypesAnalysis → FPCFAnalysis
implicit final val propertyStore: PropertyStore

Definition Classes
FPCFAnalysis
final def ps: PropertyStore

Definition Classes
FPCFAnalysis
def subtypeInheritability(isApplicationMode: Boolean)(e: Entity): Property

Determines whether a method can be inherited by a library client.
Determines whether a method can be inherited by a library client. This should not be called if the current analysis mode is application-related.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object InheritableByNewSubtypesAnalysis | package analysis

class InheritableByNewSubtypesAnalysis extends FPCFAnalysis

Usage

Implementation

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

implicit final val classHierarchy: ClassHierarchy

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isClosedLibrary: Boolean

final def isDesktopApplication: Boolean

final def isInstanceOf[T0]: Boolean

final def isJEEApplication: Boolean

final def isOpenLibrary: Boolean

implicit final val logContext: LogContext

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val project: SomeProject

implicit final val propertyStore: PropertyStore

final def ps: PropertyStore

def subtypeInheritability(isApplicationMode: Boolean)(e: Entity): Property

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from FPCFAnalysis

Inherited from AnyRef

Inherited from Any

Ungrouped