ch.usi.si.seart.cloc

Class CLOC.Builder

java.lang.Object

ch.usi.si.seart.cloc.CLOC.Builder

Enclosing class:

CLOC

public static final class CLOC.Builder
extends Object

Facilitates the construction of CLOC command instances. It allows for the step-by-step creation of these objects by providing methods for setting individual attributes. Input validations are performed at each build step.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CLOC.Builder	cores(int value) Set the number of cores to use for executing the command.
CLOC.Builder	docstringAsCode(boolean value) Controls whether cloc treats docstrings as code.
CLOC.Builder	followLinks(boolean value) Follow symbolic links to directories.
CLOC.Builder	maxFileSize(int value) Skip files exceeding the specified maximum size in megabytes.
CLOC.Builder	noRecurse(boolean value) Count files in the given directories without recursively descending into their subdirectories.
CLOC.Builder	readBinaryFiles(boolean value) Process binary files in addition to text files.
CLOC.Builder	skipUniqueness(boolean value) Skip the file uniqueness check.
@NotNull CLOC	target(@NotNull Path path) Create a new command instance targeting the specified path.
CLOC.Builder	timeout(int value) Set the timeout for executing the command.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

timeout

@Contract(value="_ -> this")
public CLOC.Builder timeout(int value)

Set the timeout for executing the command.

Parameters:

value - the timeout in seconds, or 0 for no timeout.

Returns:

this builder instance.

Throws:

IllegalArgumentException - if the timeout is less than 0.

cores

@Contract(value="_ -> this")
public CLOC.Builder cores(int value)

Set the number of cores to use for executing the command.

Parameters:

value - the number of cores to use, or 0 to disable multiprocessing.

Returns:

this builder instance.

Throws:

IllegalArgumentException - if the number of cores is lower than 0.

docstringAsCode

@Contract(value="_ -> this")
public CLOC.Builder docstringAsCode(boolean value)

Controls whether cloc treats docstrings as code. By default, docstrings are seen as comments, but they may also be regular strings in assignments or function arguments.

Parameters:

value - true to treat docstrings as code, false to treat them as comments.

Returns:

this builder instance.

followLinks

@Contract(value="_ -> this")
public CLOC.Builder followLinks(boolean value)

Follow symbolic links to directories. Symbolic links to files are always followed. Only applies to Unix-like systems.

Parameters:

value - whether symbolic links should be followed.

Returns:

this builder instance.

maxFileSize

@Contract(value="_ -> this")
public CLOC.Builder maxFileSize(int value)

Skip files exceeding the specified maximum size in megabytes. Default is 100.

The underlying command needs approximately twenty times the largest file's size in memory. Processing files larger than 100 MB on a system with less than 2 GB of RAM may lead to issues.

Parameters:

value - the maximum file size in megabytes.

Returns:

this builder instance.

noRecurse

@Contract(value="_ -> this")
public CLOC.Builder noRecurse(boolean value)

Count files in the given directories without recursively descending into their subdirectories.

Parameters:

value - whether to prevent recursion into subdirectories.

Returns:

this builder instance.

readBinaryFiles

@Contract(value="_ -> this")
public CLOC.Builder readBinaryFiles(boolean value)

Process binary files in addition to text files.

This is usually a bad idea and should only be attempted with text files that have embedded binary data.

Parameters:

value - whether to process binary files.

Returns:

this builder instance.

skipUniqueness

@Contract(value="_ -> this")
public CLOC.Builder skipUniqueness(boolean value)

Skip the file uniqueness check.

This will give a performance boost at the expense of counting files with identical contents multiple times (if such duplicates exist).

Parameters:

value - whether to skip the file uniqueness check.

Returns:

this builder instance.

target

@Contract(value="_ -> new")
 @NotNull
public @NotNull CLOC target(@NotNull
                                                                  @NotNull Path path)

Create a new command instance targeting the specified path.

Parameters:

path - the path to target, mustn't be null.

Returns:

a new command instance targeting the specified path.

Throws:

NullPointerException - if the path is null.

IllegalArgumentException - if the path doesn't exist.