Package cdc.issues.impl

Class ProfileImpl

java.lang.Object

cdc.issues.impl.ProfileImpl

All Implemented Interfaces:

Profile

public class ProfileImpl
extends Object
implements Profile

Default implementation of Profile.

Author:

Damien Carbonne

Constructor Summary

Constructors

Constructor	Description
ProfileImpl(String name)

Method Summary

Modifier and Type	Method	Description
ProfileImpl	add(Rule rule)	Adds a rule if it is not already added.
ProfileImpl	addIfMissing(Rule rule)	Adds a rule if it is not already added.
ProfileImpl	apply(ProfileConfig profileConfig)
ConfiguredRule	getConfiguredRule(Rule rule)
String	getDescription()
Labels	getLabels()
Metas	getMetas()
String	getName()
ProfileConfig	getProfileConfig()
Rule	getRule(RuleId ruleId)
Set<Rule>	getRules()
boolean	hasRule(Rule rule)
boolean	hasRule(RuleId ruleId)
ProfileImpl	remove(Rule rule)	Removes a rule.
ProfileImpl	setAllEnabled(boolean enabled)
ProfileImpl	setConfig(RuleId ruleId, RuleConfig config)
ProfileImpl	setConfig(Rule rule, RuleConfig config)
ProfileImpl	setCustomizedSeverity(RuleId ruleId, IssueSeverity customizedSeverity)
ProfileImpl	setCustomizedSeverity(Rule rule, IssueSeverity customizedSeverity)
ProfileImpl	setDescription(String description)
ProfileImpl	setEnabled(RuleId ruleId, boolean enabled)
ProfileImpl	setEnabled(Rule rule, boolean enabled)	Enables or disables a rule.
ProfileImpl	setLabels(Labels labels)
ProfileImpl	setMetas(Metas metas)
ProfileImpl	setMetas(Params metas)	Deprecated, for removal: This API element is subject to removal in a future version.
ProfileImpl	setName(String name)
ProfileImpl	setParams(RuleId ruleId, Params params)
ProfileImpl	setParams(Rule rule, Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface cdc.issues.rules.Profile

getCustomizedSeverity, getEffectiveSeverity, getEnabledRules, getParams, getRuleConfig, isEnabled

Constructor Details

ProfileImpl

public ProfileImpl(String name)

Method Details

setName

public ProfileImpl setName(String name)

setDescription

public ProfileImpl setDescription(String description)

setMetas

@Deprecated(since="2024-03-30",
            forRemoval=true)
public ProfileImpl setMetas(Params metas)

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

setMetas

public ProfileImpl setMetas(Metas metas)

setLabels

public ProfileImpl setLabels(Labels labels)

getName

public String getName()

Specified by:

getName in interface Profile

getDescription

public String getDescription()

Specified by:

getDescription in interface Profile

getMetas

public Metas getMetas()

Specified by:

getMetas in interface Profile

getLabels

public Labels getLabels()

Specified by:

getLabels in interface Profile

getRule

public Rule getRule(RuleId ruleId)

add

public ProfileImpl add(Rule rule)

Adds a rule if it is not already added.

Parameters:

rule - The rule.

Returns:

This profile.

Throws:

IllegalArgumentException - When rule is null or another rule with same id is already registered.

addIfMissing

public ProfileImpl addIfMissing(Rule rule)

Adds a rule if it is not already added.

Parameters:

rule - The rule.

Returns:

This profile.

Throws:

IllegalArgumentException - When rule is null.

setConfig

public ProfileImpl setConfig(Rule rule,
 RuleConfig config)

setConfig

public ProfileImpl setConfig(RuleId ruleId,
 RuleConfig config)

remove

public ProfileImpl remove(Rule rule)

Removes a rule.

Parameters:

rule - The rule.

Returns:

This object.

setAllEnabled

public ProfileImpl setAllEnabled(boolean enabled)

setEnabled

public ProfileImpl setEnabled(Rule rule,
 boolean enabled)

Enables or disables a rule.

If the rule is not declared, declares it.

Parameters:

rule - The rule.

enabled - true if the rule must be enabled.

Returns:

This object.

setEnabled

public ProfileImpl setEnabled(RuleId ruleId,
 boolean enabled)

setCustomizedSeverity

public ProfileImpl setCustomizedSeverity(Rule rule,
 IssueSeverity customizedSeverity)

setCustomizedSeverity

public ProfileImpl setCustomizedSeverity(RuleId ruleId,
 IssueSeverity customizedSeverity)

setParams

public ProfileImpl setParams(Rule rule,
 Params params)

setParams

public ProfileImpl setParams(RuleId ruleId,
 Params params)

apply

public ProfileImpl apply(ProfileConfig profileConfig)

getRules

public Set<Rule> getRules()

Specified by:

getRules in interface Profile

hasRule

public boolean hasRule(Rule rule)

Specified by:

hasRule in interface Profile

getProfileConfig

public ProfileConfig getProfileConfig()

Specified by:

getProfileConfig in interface Profile

hasRule

public boolean hasRule(RuleId ruleId)

Specified by:

hasRule in interface Profile

getConfiguredRule

public ConfiguredRule getConfiguredRule(Rule rule)

Specified by:

getConfiguredRule in interface Profile