Package cdc.issues.rules

Class Rule.Builder

java.lang.Object

cdc.issues.rules.Rule.Builder

All Implemented Interfaces:

LabelsBuilding<Rule.Builder>

Enclosing class:

Rule

public static class Rule.Builder
extends Object
implements LabelsBuilding<Rule.Builder>

Rule builder.

Author:

Damien Carbonne

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()

Method Summary

Modifier and Type	Method	Description
Rule.Builder	addSeverities(IssueSeverity... severities)	Deprecated, for removal: This API element is subject to removal in a future version.
Rule.Builder	addSeverities(Collection<IssueSeverity> severities)	Deprecated, for removal: This API element is subject to removal in a future version.
Rule.Builder	addSeverity(IssueSeverity severity)	Deprecated, for removal: This API element is subject to removal in a future version.
Rule	build()
Rule.Builder	description(String description)	Sets the rule description.
Rule.Builder	domain(String domain)	Sets the rule domain.
Rule.Builder	id(RuleId id)	Sets the rule id.
Rule.Builder	labels(Labels labels)
Rule.Builder	metas(Metas metas)
Rule.Builder	metas(Params metas)	Deprecated, for removal: This API element is subject to removal in a future version.
Rule.Builder	name(Enum<?> name)	Sets the rule name and its severity if the name implements IssueSeverityItem and current severity is null.
Rule.Builder	name(String name)	Sets the rule name.
Rule.Builder	params(FormalParams params)	Sets the rule formal parameters.
Rule.Builder	severities(IssueSeverity... severities)	Deprecated, for removal: This API element is subject to removal in a future version.
Rule.Builder	severities(Collection<IssueSeverity> severities)	Deprecated, for removal: This API element is subject to removal in a future version.
Rule.Builder	severity(IssueSeverity severity)	Sets the default severity of the rule.

Methods inherited from class java.lang.Object

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

Methods inherited from interface cdc.issues.LabelsBuilding

labels

Constructor Details

Builder

protected Builder()

Method Details

id

public Rule.Builder id(RuleId id)

Sets the rule id.

Parameters:

id - The id.

Returns:

This builder.

domain

public Rule.Builder domain(String domain)

Sets the rule domain.

Parameters:

domain - The domain.

Returns:

This builder.

name

public Rule.Builder name(String name)

Sets the rule name.

Parameters:

name - The name.

Returns:

This builder.

name

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

Sets the rule name and its severity if the name implements IssueSeverityItem and current severity is null.

Parameters:

name - The name.

Returns:

This builder.

severity

public Rule.Builder severity(IssueSeverity severity)

Sets the default severity of the rule.

Parameters:

severity - The severity.

Returns:

This builder.

severities

@Deprecated(since="2024-03-04",
            forRemoval=true)
public Rule.Builder severities(Collection<IssueSeverity> severities)

Deprecated, for removal: This API element is subject to removal in a future version.

severities

@Deprecated(since="2024-03-04",
            forRemoval=true)
public Rule.Builder severities(IssueSeverity... severities)

Deprecated, for removal: This API element is subject to removal in a future version.

addSeverity

@Deprecated(since="2024-03-04",
            forRemoval=true)
public Rule.Builder addSeverity(IssueSeverity severity)

Deprecated, for removal: This API element is subject to removal in a future version.

addSeverities

@Deprecated(since="2024-03-04",
            forRemoval=true)
public Rule.Builder addSeverities(Collection<IssueSeverity> severities)

Deprecated, for removal: This API element is subject to removal in a future version.

addSeverities

@Deprecated(since="2024-03-04",
            forRemoval=true)
public Rule.Builder addSeverities(IssueSeverity... severities)

Deprecated, for removal: This API element is subject to removal in a future version.

description

public Rule.Builder description(String description)

Sets the rule description.

Parameters:

description - The description.

Returns:

This builder.

params

public Rule.Builder params(FormalParams params)

Sets the rule formal parameters.

Parameters:

params - The parameters.

Returns:

This builder.

metas

@Deprecated(since="2024-03-24",
            forRemoval=true)
public Rule.Builder metas(Params metas)

Deprecated, for removal: This API element is subject to removal in a future version.

Sets the rule meta data.

Parameters:

metas - The meta data.

Returns:

This builder.

metas

public Rule.Builder metas(Metas metas)

labels

public Rule.Builder labels(Labels labels)

Specified by:

labels in interface LabelsBuilding<Rule.Builder>

build

public Rule build()