edu.hm.hafner.analysis

Class IssueBuilder

java.lang.Object

edu.hm.hafner.analysis.IssueBuilder

public class IssueBuilder
extends Object

Creates new issues using the builder pattern. All properties that have not been set in the builder will be set to their default value.

Example:

 Issue issue = new IssueBuilder()
                      .setFileName("affected.file")
                      .setLineStart(0)
                      .setCategory("JavaDoc")
                      .setMessage("Missing JavaDoc")
                      .setSeverity(Severity.WARNING_LOW);
 

Author:

Ullrich Hafner

Constructor Summary

Constructors

Constructor and Description
IssueBuilder()

Method Summary

Modifier and Type	Method and Description
Issue	build() Creates a new Issue based on the specified properties.
Optional<Issue>	buildOptional() Creates a new Issue based on the specified properties.
IssueBuilder	copy(Issue copy) Initializes this builder with an exact copy of aal properties of the specified issue.
IssueBuilder	setAdditionalProperties(Serializable additionalProperties)
IssueBuilder	setCategory(String category)
IssueBuilder	setColumnEnd(int columnEnd)
IssueBuilder	setColumnEnd(String columnEnd)
IssueBuilder	setColumnStart(int columnStart)
IssueBuilder	setColumnStart(String columnStart)
IssueBuilder	setDescription(String description)
IssueBuilder	setDirectory(String directory)
IssueBuilder	setFileName(String fileName)
IssueBuilder	setFingerprint(String fingerprint)
IssueBuilder	setId(UUID id)
IssueBuilder	setLineEnd(int lineEnd)
IssueBuilder	setLineEnd(String lineEnd)
IssueBuilder	setLineRanges(LineRangeList lineRanges)
IssueBuilder	setLineStart(int lineStart)
IssueBuilder	setLineStart(String lineStart)
IssueBuilder	setMessage(String message)
IssueBuilder	setModuleName(String moduleName)
IssueBuilder	setOrigin(String origin)
IssueBuilder	setPackageName(String packageName)
IssueBuilder	setReference(String reference)
IssueBuilder	setSeverity(Severity severity)
IssueBuilder	setType(String type)

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueBuilder

public IssueBuilder()

Method Detail

setId

public IssueBuilder setId(UUID id)

setAdditionalProperties

public IssueBuilder setAdditionalProperties(@CheckForNull
                                            Serializable additionalProperties)

setFingerprint

public IssueBuilder setFingerprint(@CheckForNull
                                   String fingerprint)

setFileName

public IssueBuilder setFileName(@CheckForNull
                                String fileName)

setDirectory

public IssueBuilder setDirectory(@CheckForNull
                                 String directory)

setLineStart

public IssueBuilder setLineStart(@CheckForNull
                                 int lineStart)

setLineStart

public IssueBuilder setLineStart(@CheckForNull
                                 String lineStart)

setLineEnd

public IssueBuilder setLineEnd(@CheckForNull
                               int lineEnd)

setLineEnd

public IssueBuilder setLineEnd(@CheckForNull
                               String lineEnd)

setColumnStart

public IssueBuilder setColumnStart(int columnStart)

setColumnStart

public IssueBuilder setColumnStart(String columnStart)

setColumnEnd

public IssueBuilder setColumnEnd(int columnEnd)

setColumnEnd

public IssueBuilder setColumnEnd(String columnEnd)

setCategory

public IssueBuilder setCategory(@CheckForNull
                                String category)

setType

public IssueBuilder setType(@CheckForNull
                            String type)

setPackageName

public IssueBuilder setPackageName(@CheckForNull
                                   String packageName)

setModuleName

public IssueBuilder setModuleName(@CheckForNull
                                  String moduleName)

setOrigin

public IssueBuilder setOrigin(@CheckForNull
                              String origin)

setReference

public IssueBuilder setReference(@CheckForNull
                                 String reference)

setSeverity

public IssueBuilder setSeverity(@CheckForNull
                                Severity severity)

setMessage

public IssueBuilder setMessage(@CheckForNull
                               String message)

setDescription

public IssueBuilder setDescription(@CheckForNull
                                   String description)

setLineRanges

public IssueBuilder setLineRanges(LineRangeList lineRanges)

copy

public IssueBuilder copy(Issue copy)

Initializes this builder with an exact copy of aal properties of the specified issue.

Parameters:

copy - the issue to copy the properties from

Returns:

the initialized builder

build

public Issue build()

Creates a new Issue based on the specified properties.

Returns:

the created issue

buildOptional

public Optional<Issue> buildOptional()

Creates a new Issue based on the specified properties. The returned issue is wrapped in an Optional.

Returns:

the created issue