Package cdc.issues.api

Class Issue.Builder

java.lang.Object

cdc.issues.api.Issue.Builder

Direct Known Subclasses:

Issue.AbstractIssueBuilder

Enclosing class:

Issue

public static class Issue.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description
protected String	domain
protected List<Location>	locations
protected String	name
protected Params	params
protected IssueSeverity	severity
protected Instant	timestamp

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()

Method Summary

Modifier and Type	Method	Description
Issue.Builder	addLocation(Location location)	Adds an issue location.
Issue	build()
Issue.Builder	description(String description)	Sets the issue description.
Issue.Builder	domain(String domain)	Sets the issue domain.
Issue.Builder	locations(Location[] locations)	Sets the issue locations.
Issue.Builder	locations(List<Location> locations)	Sets the issue locations.
Issue.Builder	name(Enum<?> name)	Sets the issue name and its severity if the passed enum implements IssueSeverityItem.
Issue.Builder	name(String name)	Sets the issue name.
Issue.Builder	params(Params params)	Sets the issue rule parameters.
Issue.Builder	ruleId(RuleId ruleId)	Sets the issue RuleId.
protected Issue.Builder	self()
Issue.Builder	severity(IssueSeverity severity)	Sets the issue severity.
Issue.Builder	timestamp(Instant timestamp)	Sets the issue timestamp.

Methods inherited from class java.lang.Object

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

Field Detail

timestamp

protected Instant timestamp

domain

protected String domain

name

protected String name

params

protected Params params

severity

protected IssueSeverity severity

description

protected String description

locations

protected final List<Location> locations

Constructor Detail

Builder

protected Builder()

Method Detail

self

protected Issue.Builder self()

timestamp

public Issue.Builder timestamp(Instant timestamp)

Sets the issue timestamp.

WARNING: this should only be used to reconstruct an issue -from a file, stream, ...).

Parameters:

timestamp - The timestamp.

Returns:

This builder.

ruleId

public Issue.Builder ruleId(RuleId ruleId)

Sets the issue RuleId.

This is equivalent to setting its domain and name.

Parameters:

ruleId - The rule id.

Returns:

This builder.

domain

public Issue.Builder domain(String domain)

Sets the issue domain.

Parameters:

domain - The domain.

Returns:

This builder.

name

public Issue.Builder name(String name)

Sets the issue name.

Parameters:

name - The name.

Returns:

This builder.

name

public Issue.Builder name(Enum<?> name)

Sets the issue name and its severity if the passed enum implements IssueSeverityItem.

Parameters:

name - The name.

Returns:

This builder.

params

public Issue.Builder params(Params params)

Sets the issue rule parameters.

Parameters:

params - The parameters.

Returns:

This builder.

addLocation

public Issue.Builder addLocation(Location location)

Adds an issue location.

Parameters:

location - The location.

Returns:

This builder.

locations

public Issue.Builder locations(Location[] locations)

Sets the issue locations.

Parameters:

locations - The locations

Returns:

This builder.

locations

public Issue.Builder locations(List<Location> locations)

Sets the issue locations.

Parameters:

locations - The locations

Returns:

This builder.

severity

public Issue.Builder severity(IssueSeverity severity)

Sets the issue severity.

Parameters:

severity - The severity.

Returns:

This builder.

description

public Issue.Builder description(String description)

Sets the issue description.

Parameters:

description - The description.

Returns:

This builder.

build

public Issue build()