FactoryMethodAnalysis

This analysis identifies a project's factory methods.

A method is no factory method if:

it is not static and does not invoke the constructor of the class where it is declared.

This information is relevant in various contexts, e.g., to determine the instantiability of a class.

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(FactoryMethodAnalysis)

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 theProjectStore = theProject.get(SourceElementsPropertyStoreKey)
val factoryMethods = theProjectStore.entities { (p: Property) ⇒
p == IsFactoryMethod
}

Note: Native methods are considered as factory methods because they might instantiate the class.

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( ... )
def determineProperty(method: Method): PropertyComputationResult

Determines if the given method is a factory method.
Determines if the given method is a factory method. Any native method is considered as factory method, because we have to assume, that it creates an instance of the class. This checks not for effective factory methods, since the return type of the method is ignored. A method is either native or the constructor of the declaring class is invoked.
Possible improvements:
- check if the method returns an instance of the class or some superclass.
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
FactoryMethodAnalysis → FPCFAnalysis
implicit final val propertyStore: PropertyStore

Definition Classes
FPCFAnalysis
final def ps: PropertyStore

Definition Classes
FPCFAnalysis
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 FactoryMethodAnalysis | package analysis

class FactoryMethodAnalysis extends FPCFAnalysis

Usage

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

def determineProperty(method: Method): PropertyComputationResult

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

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