com.atlassian.clover.registry.entities

Class ParentEntity

java.lang.Object

com.atlassian.clover.registry.entities.ParentEntity

public class ParentEntity
extends Object

Helper class holding a reference to a parent of one of the following code entities:

• StatementInfo
• MethodInfo
• ClassInfo

A statement/method/class can be declared inside:

• MethodInfo - e.g. code statements of the method, inline classes declared, inner functions
• ClassInfo - e.g. class members (functions, inner classes)
• FileInfo - e.g. top-level functions, statements

A file as parent always exists, but two others not. Thus the containingClass and containingMethod are being set exclusively, i.e. only of them can be non-null (it can also happen that both are null).

Constructor Summary

Constructors

Constructor and Description
ParentEntity(ClassInfo containingClass)
ParentEntity(EntityContainer parentEntity, FileInfo containingFile)
ParentEntity(FileInfo containingFile)
ParentEntity(MethodInfo containingMethod)

Method Summary

Modifier and Type	Method and Description
ClassInfo	getContainingClass()
FileInfo	getContainingFile()
MethodInfo	getContainingMethod()
EntityContainer	getParentEntity()
void	setContainingFile(FullFileInfo fileInfo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParentEntity

public ParentEntity(@NotNull
                    ClassInfo containingClass)

ParentEntity

public ParentEntity(@NotNull
                    MethodInfo containingMethod)

ParentEntity

public ParentEntity(@NotNull
                    FileInfo containingFile)

ParentEntity

public ParentEntity(@NotNull
                    EntityContainer parentEntity,
                    @Nullable
                    FileInfo containingFile)

Method Detail

getContainingClass

@Nullable
public ClassInfo getContainingClass()

getContainingFile

@Nullable
public FileInfo getContainingFile()

getContainingMethod

@Nullable
public MethodInfo getContainingMethod()

getParentEntity

@NotNull
public EntityContainer getParentEntity()

setContainingFile

public void setContainingFile(@NotNull
                              FullFileInfo fileInfo)