BaseClassInfo (OpenClover 4.5.2 API)

java.lang.Object
- com.atlassian.clover.registry.FixedFileRegion
- - com.atlassian.clover.registry.entities.BaseClassInfo

All Implemented Interfaces:

ClassInfo, EntityContainer, HasAggregatedMetrics, HasClasses, HasContextFilter, HasMethods, HasMetrics, HasParent, HasStatements, SourceInfo, FileInfoRegion

Direct Known Subclasses:

FullClassInfo
```
public class BaseClassInfo
extends FixedFileRegion
implements ClassInfo
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected ContextSet`	`contextFilter`
`protected BlockMetrics`	`metrics`
`protected Modifiers`	`modifiers` Class modifiers (like public, static) with class annotations
`protected String`	`name` Base class name
`protected BasePackageInfo`	`packageInfo`
`protected String`	`qualifiedName` Fully qualified class name
`protected BlockMetrics`	`rawMetrics`
`protected boolean`	`testClass` Whether this object is a test class (according to custom or default test detector
`protected boolean`	`typeAnnotation` Whether this object is an annotation
`protected boolean`	`typeEnum` Whether this object is an enum
`protected boolean`	`typeInterface` Whether this object is an interface

Fields inherited from class com.atlassian.clover.registry.FixedFileRegion
containingFile, region

Constructor Summary

Constructors
Modifier	Constructor and Description
	`BaseClassInfo(BasePackageInfo packageInfo, BaseFileInfo containingFile, String name, SourceInfo region, Modifiers modifiers, boolean typeInterface, boolean typeEnum, boolean typeAnnotation)`
`protected`	`BaseClassInfo(String name, String qualifiedName, SourceInfo region, Modifiers modifiers, boolean typeInterface, boolean typeEnum, boolean typeAnnotation, boolean testClass)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAggregatedComplexity()`
`int`	`getAggregatedStatementCount()`
`List<? extends ClassInfo>`	`getAllClasses()` Returns list of all classes, including indirect descendants.
`List<? extends MethodInfo>`	`getAllMethods()` Returns list of all methods, including indirect descendants.
`List<? extends ClassInfo>`	`getClasses()` Returns list of inner classes declared on the top level of the class.
`ClassInfo`	`getContainingClass()` Returns a class in which this class is declared (case for inner classes) or `null` otherwise.
`FileInfo`	`getContainingFile()` Returns a file in which this class is declared.
`MethodInfo`	`getContainingMethod()` Returns a method in which this class (an anonymous inline class for instance) is declared or `null` otherwise.
`ContextSet`	`getContextFilter()` Returns context filter for the entity, i.e set of custom statement/method contexts as well as Clover's built-in code contexts.
`List<? extends MethodInfo>`	`getMethods()` Returns list of methods declared on the top level of the class.
`BlockMetrics`	`getMetrics()`
`ModifiersInfo`	`getModifiers()`
`String`	`getName()`
`PackageInfo`	`getPackage()`
`EntityContainer`	`getParent()`
`String`	`getQualifiedName()`
`BlockMetrics`	`getRawMetrics()`
`List<? extends StatementInfo>`	`getStatements()` Returns list of statements declared on the to level of the class, i.e.
`boolean`	`isAnnotationType()`
`boolean`	`isEmpty()` Returns true if this class does not contain any nested entities (method or inner classes)
`boolean`	`isEnum()`
`boolean`	`isInterface()`
`boolean`	`isTestClass()`
`void`	`setAggregatedComplexity(int aggregatedComplexity)`
`void`	`setAggregatedStatementCount(int aggregatedStatements)`
`void`	`setMetrics(BlockMetrics metrics)`
`String`	`toString()`
`void`	`visit(EntityVisitor entityVisitor)` Visit yourself

Methods inherited from class com.atlassian.clover.registry.FixedFileRegion
getEndColumn, getEndLine, getStartColumn, getStartLine

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.clover.api.registry.SourceInfo
getEndColumn, getEndLine, getStartColumn, getStartLine

- Field Detail
  - name
```
protected String name
```
    Base class name
  - qualifiedName
```
protected String qualifiedName
```
    Fully qualified class name
  - modifiers
```
protected Modifiers modifiers
```
    Class modifiers (like public, static) with class annotations
  - typeInterface
```
protected boolean typeInterface
```
    Whether this object is an interface
  - typeEnum
```
protected boolean typeEnum
```
    Whether this object is an enum
  - typeAnnotation
```
protected boolean typeAnnotation
```
    Whether this object is an annotation
  - testClass
```
protected boolean testClass
```
    Whether this object is a test class (according to custom or default test detector
  - packageInfo
```
protected transient BasePackageInfo packageInfo
```
  - rawMetrics
```
protected transient BlockMetrics rawMetrics
```
  - metrics
```
protected transient BlockMetrics metrics
```
  - contextFilter
```
protected transient ContextSet contextFilter
```
- Constructor Detail
  - BaseClassInfo
```
public BaseClassInfo(BasePackageInfo packageInfo,
                     BaseFileInfo containingFile,
                     String name,
                     SourceInfo region,
                     Modifiers modifiers,
                     boolean typeInterface,
                     boolean typeEnum,
                     boolean typeAnnotation)
```
  - BaseClassInfo
```
protected BaseClassInfo(String name,
                        String qualifiedName,
                        SourceInfo region,
                        Modifiers modifiers,
                        boolean typeInterface,
                        boolean typeEnum,
                        boolean typeAnnotation,
                        boolean testClass)
```
- Method Detail
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface ClassInfo
    
    Specified by:
    
    getName in interface HasMetrics
  - getQualifiedName
```
public String getQualifiedName()
```
    Specified by:
    
    getQualifiedName in interface ClassInfo
  - getModifiers
```
public ModifiersInfo getModifiers()
```
    Specified by:
    
    getModifiers in interface ClassInfo
  - getContainingClass
```
@Nullable
public ClassInfo getContainingClass()
```
    Description copied from interface: ClassInfo
    
    Returns a class in which this class is declared (case for inner classes) or null otherwise.
    
    Specified by:
    
    getContainingClass in interface ClassInfo
    
    Returns:
    
    ClassInfo containing class or null
  - getContainingMethod
```
@Nullable
public MethodInfo getContainingMethod()
```
    Description copied from interface: ClassInfo
    
    Returns a method in which this class (an anonymous inline class for instance) is declared or null otherwise.
    
    Specified by:
    
    getContainingMethod in interface ClassInfo
    
    Returns:
    
    MethodInfo containing method or null
  - getContainingFile
```
@Nullable
public FileInfo getContainingFile()
```
    Description copied from interface: ClassInfo
    
    Returns a file in which this class is declared.
    
    Specified by:
    
    getContainingFile in interface ClassInfo
    
    Specified by:
    
    getContainingFile in interface FileInfoRegion
    
    Overrides:
    
    getContainingFile in class FixedFileRegion
    
    Returns:
    
    FileInfo file containing this class
  - getParent
```
public EntityContainer getParent()
```
    Specified by:
    
    getParent in interface HasParent
  - getPackage
```
public PackageInfo getPackage()
```
    Specified by:
    
    getPackage in interface ClassInfo
  - isInterface
```
public boolean isInterface()
```
  - isEnum
```
public boolean isEnum()
```
  - isAnnotationType
```
public boolean isAnnotationType()
```
  - getRawMetrics
```
public BlockMetrics getRawMetrics()
```
    Specified by:
    
    getRawMetrics in interface HasMetrics
  - getMetrics
```
public BlockMetrics getMetrics()
```
    Specified by:
    
    getMetrics in interface HasMetrics
  - setMetrics
```
public void setMetrics(BlockMetrics metrics)
```
    Specified by:
    
    setMetrics in interface HasMetrics
  - isTestClass
```
public boolean isTestClass()
```
    Specified by:
    
    isTestClass in interface ClassInfo
  - getClasses
```
@NotNull
public List<? extends ClassInfo> getClasses()
```
    Description copied from interface: ClassInfo
    Returns list of inner classes declared on the top level of the class. It does not return classes declared inside other inner classes, i.e nested more than one level. Exact content depends on a programming language, e.g.:
    - Java and Groovy - it does not return anonymous inline classes (they're treated like statements)
    - Scala - t.b.d.
    Specified by:
    
    getClasses in interface ClassInfo
    
    Specified by:
    
    getClasses in interface HasClasses
    
    Returns:
    
    List<? extends ClassInfo> - list of classes or empty list if none
  - getAllClasses
```
@NotNull
public List<? extends ClassInfo> getAllClasses()
```
    Description copied from interface: HasClasses
    
    Returns list of all classes, including indirect descendants.
    
    Specified by:
    
    getAllClasses in interface HasClasses
    
    Returns:
    
    List<? extends ClassInfo> - list of classes or empty list if none
  - getMethods
```
@NotNull
public List<? extends MethodInfo> getMethods()
```
    Description copied from interface: ClassInfo
    Returns list of methods declared on the top level of the class. It does not return methods declared in nested classes or methods declared inside other methods etc. Exact content depends on a programming language, e.g.:
    - Java - traditional methods plus lambda functions assigned to a field (java 8 or above)
    - Groovy - methods, extra methods generated by groovyc (getters and setters for instance)
    - Scala - t.b.d.
    Specified by:
    
    getMethods in interface ClassInfo
    
    Specified by:
    
    getMethods in interface HasMethods
    
    Returns:
    
    List<? extends MethodInfo> - list of methods or empty list if none
  - getAllMethods
```
@NotNull
public List<? extends MethodInfo> getAllMethods()
```
    Description copied from interface: HasMethods
    
    Returns list of all methods, including indirect descendants.
    
    Specified by:
    
    getAllMethods in interface HasMethods
    
    Returns:
    
    List<? extends MethodInfo> - list of methods or empty list if none
  - getStatements
```
@NotNull
public List<? extends StatementInfo> getStatements()
```
    Description copied from interface: ClassInfo
    Returns list of statements declared on the to level of the class, i.e. outside methods. It does not apply to all programming languages:
    - Java - not applicable, code put in static initializer blocks is treated as a part of a constructor
    - Groovy - not applicable
    - Scala - t.b.d.
    Specified by:
    
    getStatements in interface ClassInfo
    
    Specified by:
    
    getStatements in interface HasStatements
    
    Returns:
    
    List<? extends StatementInfo> - list of statements or empty list if none
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: ClassInfo
    
    Returns true if this class does not contain any nested entities (method or inner classes)
    
    Specified by:
    
    isEmpty in interface ClassInfo
    
    Returns:
    
    boolean - true if getMethods() is empty and getClasses() is empty
  - getContextFilter
```
public ContextSet getContextFilter()
```
    Description copied from interface: HasContextFilter
    
    Returns context filter for the entity, i.e set of custom statement/method contexts as well as Clover's built-in code contexts.
    
    Specified by:
    
    getContextFilter in interface HasContextFilter
    
    Returns:
    
    ContextSet
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getAggregatedComplexity
```
public int getAggregatedComplexity()
```
    Specified by:
    
    getAggregatedComplexity in interface HasAggregatedMetrics
  - setAggregatedComplexity
```
public void setAggregatedComplexity(int aggregatedComplexity)
```
    Specified by:
    
    setAggregatedComplexity in interface HasAggregatedMetrics
  - getAggregatedStatementCount
```
public int getAggregatedStatementCount()
```
    Specified by:
    
    getAggregatedStatementCount in interface HasAggregatedMetrics
  - setAggregatedStatementCount
```
public void setAggregatedStatementCount(int aggregatedStatements)
```
    Specified by:
    
    setAggregatedStatementCount in interface HasAggregatedMetrics
  - visit
```
public void visit(EntityVisitor entityVisitor)
```
    Visit yourself
    
    Specified by:
    
    visit in interface EntityContainer
    
    Parameters:
    
    entityVisitor - callback

Class BaseClassInfo

Field Summary

Fields inherited from class com.atlassian.clover.registry.FixedFileRegion

Constructor Summary

Method Summary

Methods inherited from class com.atlassian.clover.registry.FixedFileRegion

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlassian.clover.api.registry.SourceInfo

Field Detail

name

qualifiedName

modifiers

typeInterface

typeEnum

typeAnnotation

testClass

packageInfo

rawMetrics

metrics

contextFilter

Constructor Detail

BaseClassInfo

BaseClassInfo

Method Detail

getName

getQualifiedName

getModifiers

getContainingClass

getContainingMethod

getContainingFile

getParent

getPackage

isInterface

isEnum

isAnnotationType

getRawMetrics

getMetrics

setMetrics

isTestClass

getClasses

getAllClasses

getMethods

getAllMethods

getStatements

isEmpty

getContextFilter

toString

getAggregatedComplexity

setAggregatedComplexity

getAggregatedStatementCount

setAggregatedStatementCount

visit