Package org.myire.scent.metrics

Class ModuleDeclarationMetrics

java.lang.Object

org.myire.scent.metrics.CodeElementMetrics

org.myire.scent.metrics.ModuleDeclarationMetrics

@NotThreadSafe
public class ModuleDeclarationMetrics
extends CodeElementMetrics

Source code metrics for a module declaration.

Instances of this class are not safe for use by multiple threads without external synchronization.

Author:

Peter Franzen

Constructor Summary

Constructors

Constructor	Description
ModuleDeclarationMetrics(java.lang.String pName, boolean pIsOpen)	Create a new ModuleDeclarationMetrics.

Method Summary

Modifier and Type	Method	Description
void	add(com.github.javaparser.ast.modules.ModuleExportsStmt pStatement)	Add metrics of an exports statement.
void	add(com.github.javaparser.ast.modules.ModuleOpensStmt pStatement)	Add metrics of an opens statement.
void	add(com.github.javaparser.ast.modules.ModuleProvidesStmt pStatement)	Add metrics of a provides statement.
void	add(com.github.javaparser.ast.modules.ModuleRequiresStmt pStatement)	Add metrics of a requires statement.
void	add(com.github.javaparser.ast.modules.ModuleUsesStmt pStatement)	Add metrics of a uses statement.
int	getNumExportsStatements()	Get the number of exports statements added to this instance.
int	getNumOpensStatements()	Get the number of opens statements added to this instance.
int	getNumProvidesStatements()	Get the number of provides statements added to this instance.
int	getNumRequiresStatements()	Get the number of requires statements added to this instance.
int	getNumUsesStatements()	Get the number of uses statements added to this instance.
boolean	isOpen()	Is the module declared as open?

Methods inherited from class org.myire.scent.metrics.CodeElementMetrics

getComments, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleDeclarationMetrics

public ModuleDeclarationMetrics(@Nonnull
                                java.lang.String pName,
                                boolean pIsOpen)

Create a new ModuleDeclarationMetrics.

Parameters:

pName - The name of the module.

pIsOpen - True if the module is an open module, false if not.

Throws:

java.lang.NullPointerException - if pName is null.

Method Detail

isOpen

public boolean isOpen()

Is the module declared as open?

Returns:

True if the module is open, false if not.

getNumRequiresStatements

public int getNumRequiresStatements()

Get the number of requires statements added to this instance.

Returns:

The number of requires statements.

getNumExportsStatements

public int getNumExportsStatements()

Get the number of exports statements added to this instance.

Returns:

The number of exports statements.

getNumProvidesStatements

public int getNumProvidesStatements()

Get the number of provides statements added to this instance.

Returns:

The number of provides statements.

getNumUsesStatements

public int getNumUsesStatements()

Get the number of uses statements added to this instance.

Returns:

The number of uses statements.

getNumOpensStatements

public int getNumOpensStatements()

Get the number of opens statements added to this instance.

Returns:

The number of opens statements.

add

public void add(@Nonnull
                com.github.javaparser.ast.modules.ModuleRequiresStmt pStatement)

Add metrics of a requires statement.

Parameters:

pStatement - The statement.

Throws:

java.lang.NullPointerException - if pStatement is null.

add

public void add(@Nonnull
                com.github.javaparser.ast.modules.ModuleExportsStmt pStatement)

Add metrics of an exports statement.

Parameters:

pStatement - The statement.

Throws:

java.lang.NullPointerException - if pStatement is null.

add

public void add(@Nonnull
                com.github.javaparser.ast.modules.ModuleProvidesStmt pStatement)

Add metrics of a provides statement.

Parameters:

pStatement - The statement.

Throws:

java.lang.NullPointerException - if pStatement is null.

add

public void add(@Nonnull
                com.github.javaparser.ast.modules.ModuleUsesStmt pStatement)

Add metrics of a uses statement.

Parameters:

pStatement - The statement.

Throws:

java.lang.NullPointerException - if pStatement is null.

add

public void add(@Nonnull
                com.github.javaparser.ast.modules.ModuleOpensStmt pStatement)

Add metrics of an opens statement.

Parameters:

pStatement - The statement.

Throws:

java.lang.NullPointerException - if pStatement is null.