hudson.plugins.sloccount.model

Class SloccountReport

java.lang.Object

hudson.plugins.sloccount.model.FileContainer

hudson.plugins.sloccount.model.SloccountReport

All Implemented Interfaces:

Countable, SloccountReportInterface, Serializable

public class SloccountReport
extends FileContainer
implements SloccountReportInterface

Author:

lordofthepigs

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIRECTORY_SEPARATOR Only Unix directory separator is used in the code.

Constructor Summary

Constructors

Constructor and Description
SloccountReport()
SloccountReport(SloccountReport old, FileFilter filter)

Method Summary

Modifier and Type	Method and Description
void	add(String filePath, String languageName, String moduleName, int lineCount, int commentCount) Add lines count.
void	addFolder(Folder folder)
void	addLanguage(Language language)
void	addModule(Module module) Add a new module.
static String	extractFolder(String filePath) Extract directory part of a path.
Folder	getFolder(String name)
int	getFolderCount()
String	getFolderCountString()
List<Folder>	getFolders()
Language	getLanguage(String name)
int	getLanguageCount()
String	getLanguageCountString()
List<Language>	getLanguages()
File	getLongestFile()
Folder	getLongestFolder()
Language	getLongestLanguage()
Module	getLongestModule() Get the longest module.
Module	getModule(String name) Get module using its name.
int	getModuleCount() Get count of all modules.
String	getModuleCountString() Get count of all modules as string.
List<Module>	getModules() Get all modules.
String	getName()
String	getRootFolder() Get the root folder.
void	simplifyNames() Simplify the names.

Methods inherited from class hudson.plugins.sloccount.model.FileContainer

addFile, getCommentCount, getCommentCountString, getFile, getFileCount, getFileCountString, getFiles, getLineCount, getLineCountString

Methods inherited from class java.lang.Object

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

Field Detail

DIRECTORY_SEPARATOR

public static final String DIRECTORY_SEPARATOR

Only Unix directory separator is used in the code.

See Also:

Constant Field Values

Constructor Detail

SloccountReport

public SloccountReport()

SloccountReport

public SloccountReport(SloccountReport old,
                       FileFilter filter)

Method Detail

add

public void add(String filePath,
                String languageName,
                String moduleName,
                int lineCount,
                int commentCount)

Description copied from interface: SloccountReportInterface

Add lines count.

Specified by:

add in interface SloccountReportInterface

Parameters:

filePath - the file

languageName - the language name

moduleName - the module name

lineCount - the line count

commentCount - the comment count

extractFolder

public static String extractFolder(String filePath)

Extract directory part of a path. The method searches first directory separator from right. Examples of input and output: (empty string) - (empty string) file.java - (empty string) / - / /test/file.java - /test/ /cygdrive/c/test/file.java - /cygdrive/c/test/ c:/test/file.java - c:/test/ /test/ - /test/ /test - / ... is it file or directory?

Parameters:

filePath - the path containing folders and file name, Unix separators '/' are expected

Returns:

the path without the file name; if no separator is found in the input path an empty string will be returned

getFolder

public Folder getFolder(String name)

getFolders

public List<Folder> getFolders()

getFolderCount

public int getFolderCount()

getFolderCountString

public String getFolderCountString()

getLanguage

public Language getLanguage(String name)

getLanguages

public List<Language> getLanguages()

getLanguageCount

public int getLanguageCount()

getLanguageCountString

public String getLanguageCountString()

getModule

public Module getModule(String name)

Get module using its name.

Parameters:

name - the module name

Returns:

the module or null if not defined

getModules

public List<Module> getModules()

Get all modules.

Returns:

the modules or empty list if no module is defined

getModuleCount

public int getModuleCount()

Get count of all modules.

Returns:

the count

getModuleCountString

public String getModuleCountString()

Get count of all modules as string.

Returns:

the count

addFolder

public void addFolder(Folder folder)

addLanguage

public void addLanguage(Language language)

addModule

public void addModule(Module module)

Add a new module.

Parameters:

module - the module

getRootFolder

public String getRootFolder()

Description copied from interface: SloccountReportInterface

Get the root folder.

Specified by:

getRootFolder in interface SloccountReportInterface

Returns:

the root folder

getLongestFile

public File getLongestFile()

getLongestFolder

public Folder getLongestFolder()

getLongestLanguage

public Language getLongestLanguage()

getLongestModule

public Module getLongestModule()

Get the longest module.

Returns:

the longest module

simplifyNames

public void simplifyNames()

Simplify the names.

getName

public String getName()

Specified by:

getName in interface Countable