ch.usi.si.seart.cloc

Class CLOC

java.lang.Object

ch.usi.si.seart.cloc.CLOC

public final class CLOC
extends Object

Counts blank lines, comment lines, and physical lines of source code in many programming languages.

Author:

Ozren Dabić

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CLOC.Builder Facilitates the construction of CLOC command instances.

Method Summary

Modifier and Type	Method and Description
static CLOC.Builder	command() Obtain a new Builder for constructing a command.
com.fasterxml.jackson.databind.node.ObjectNode	countFiles() Count the number of files, reporting results by language.
static @Nullable String	getMD5()
static @Nullable String	getURL()
static @Nullable String	getVersion()
com.fasterxml.jackson.databind.node.ObjectNode	linesByFile() Count the physical lines of source code, reporting results by file.
com.fasterxml.jackson.databind.node.ObjectNode	linesByFileAndLanguage() Count the physical lines of source code, reporting results by file and language.
com.fasterxml.jackson.databind.node.ObjectNode	linesByLanguage() Count the physical lines of source code, reporting results by language.
static void	setOutputMapper(@Nullable com.fasterxml.jackson.databind.json.JsonMapper mapper) Set the JsonMapper to use for parsing the output of the command.

Methods inherited from class java.lang.Object

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

Method Detail

getURL

@Nullable
public static @Nullable String getURL()

Returns:

the cloc repository link, or null if the details could not be loaded.

getVersion

@Nullable
public static @Nullable String getVersion()

Returns:

the cloc command version, or null if the details could not be loaded.

getMD5

@Nullable
public static @Nullable String getMD5()

Returns:

the cloc executable MD5 checksum, or null if the details could not be loaded.

setOutputMapper

public static void setOutputMapper(@Nullable
                                   @Nullable com.fasterxml.jackson.databind.json.JsonMapper mapper)

Set the JsonMapper to use for parsing the output of the command.

Parameters:

mapper - the mapper to use, or null to revert to the default instance.

command

public static CLOC.Builder command()

Obtain a new Builder for constructing a command.

Returns:

a new command builder instance.

linesByLanguage

public com.fasterxml.jackson.databind.node.ObjectNode linesByLanguage()
                                                               throws CLOCException

Count the physical lines of source code, reporting results by language.

Returns:

A JSON object representation of the command output.

Throws:

CLOCException - if an error occurs while executing the command.

linesByFile

public com.fasterxml.jackson.databind.node.ObjectNode linesByFile()
                                                           throws CLOCException

Count the physical lines of source code, reporting results by file.

Returns:

A JSON object representation of the command output.

Throws:

CLOCException - if an error occurs while executing the command.

linesByFileAndLanguage

public com.fasterxml.jackson.databind.node.ObjectNode linesByFileAndLanguage()
                                                                      throws CLOCException

Count the physical lines of source code, reporting results by file and language.

Returns:

A JSON object representation of the command output.

Throws:

CLOCException - if an error occurs while executing the command.

countFiles

public com.fasterxml.jackson.databind.node.ObjectNode countFiles()
                                                          throws CLOCException

Count the number of files, reporting results by language.

Returns:

A JSON object representation of the command output.

Throws:

CLOCException - if an error occurs while executing the command.