Package com.e1c.g5.v8.dt.internal.check.settings

Class CheckSettings

java.lang.Object

com.e1c.g5.v8.dt.internal.check.settings.CheckSettings

All Implemented Interfaces:

ICheckSettings, INamedElement

public class CheckSettings
extends Object
implements ICheckSettings

Base implementation for ICheckSettings.

Field Summary

Fields inherited from interface com.e1c.g5.v8.dt.check.settings.INamedElement

ROOT_ID

Constructor Summary

Constructors

Constructor	Description
CheckSettings(CheckUid checkUid, CheckUid parentId, String title, String description, boolean enabled, boolean originalEnabled, IssueSeverity severity, IssueSeverity originalSeverity, IssueType issueType, Map<String,ICheckParameterSettings> parameters)	Constructs check settings instance
CheckSettings(CheckUid checkUid, CheckUid parentId, String title, Supplier<String> description, boolean enabled, boolean protectedObjectCheckEnabled, boolean originalEnabled, IssueSeverity severity, IssueSeverity originalSeverity, IssueType issueType, Map<String,ICheckParameterSettings> parameters)	Creates new instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDescription()	Returns localized description.
CheckUid	getId()	Gets the unique idenfier of the check
Map<String,ICheckParameterSettings>	getParameters()	Returns the immutable map of check properties by names.
CheckUid	getParentId()	Returns parent id.
IssueSeverity	getSeverity()	Gets the severity of the check as configured
String	getTitle()	Returns localized title.
IssueType	getType()	Gets the type of the check issues
int	hashCode()
boolean	isDefault()	Returns whether check settings is default.
boolean	isEnabled()	Reads the enablement status of the check
boolean	isProtectedObjectCheckEnabled()	Reads the protected object check mode enablement status
void	setEnabled(boolean enabled)	Sets check enabling.
void	setSeverity(IssueSeverity severity)	Sets check severity.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CheckSettings

public CheckSettings(CheckUid checkUid,
 CheckUid parentId,
 String title,
 String description,
 boolean enabled,
 boolean originalEnabled,
 IssueSeverity severity,
 IssueSeverity originalSeverity,
 IssueType issueType,
 Map<String,ICheckParameterSettings> parameters)

Constructs check settings instance

Parameters:

checkId - The identifier of the check. May not be null

parentId - The identifier of the parent category. May not be null

title - The default title of the check

description -

enabled -

originalEnabled -

severity -

originalSeverity -

issueType -

parameters -

CheckSettings

public CheckSettings(CheckUid checkUid,
 CheckUid parentId,
 String title,
 Supplier<String> description,
 boolean enabled,
 boolean protectedObjectCheckEnabled,
 boolean originalEnabled,
 IssueSeverity severity,
 IssueSeverity originalSeverity,
 IssueType issueType,
 Map<String,ICheckParameterSettings> parameters)

Creates new instance.

Parameters:

checkUid - check id, not null

title - check title, not null

description - check description, not null

issueType - check issue type, not null

enabled - enabled,

protectedObjectCheckEnabled -

severity - check severity, not null

parentId - category id from from extension point "com.e1c.g5.v8.dt.check.category" or null if none

properties - check properties, not null

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getId

public CheckUid getId()

Description copied from interface: ICheckSettings

Gets the unique idenfier of the check

Specified by:

getId in interface ICheckSettings

Specified by:

getId in interface INamedElement

Returns:

The unique identifier of the check. May not be null

getDescription

public String getDescription()

Description copied from interface: INamedElement

Returns localized description.

Specified by:

getDescription in interface INamedElement

Returns:

title, not null

getParameters

public Map<String,ICheckParameterSettings> getParameters()

Description copied from interface: ICheckSettings

Returns the immutable map of check properties by names.

Specified by:

getParameters in interface ICheckSettings

Returns:

map of check properties by names, not null.

getParentId

public CheckUid getParentId()

Description copied from interface: INamedElement

Returns parent id.

Specified by:

getParentId in interface INamedElement

Returns:

parent id, empty string if empty, not null

getSeverity

public IssueSeverity getSeverity()

Description copied from interface: ICheckSettings

Gets the severity of the check as configured

Specified by:

getSeverity in interface ICheckSettings

Returns:

The severity of the check. May not be null

getTitle

public String getTitle()

Description copied from interface: INamedElement

Returns localized title.

Specified by:

getTitle in interface INamedElement

Returns:

title, not null

getType

public IssueType getType()

Description copied from interface: ICheckSettings

Gets the type of the check issues

Specified by:

getType in interface ICheckSettings

Returns:

The type of the check issues. May not be null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isDefault

public boolean isDefault()

Description copied from interface: ICheckSettings

Returns whether check settings is default.

Specified by:

isDefault in interface ICheckSettings

Returns:

whether check settings is default.

isEnabled

public boolean isEnabled()

Description copied from interface: ICheckSettings

Reads the enablement status of the check

Specified by:

isEnabled in interface ICheckSettings

Returns:

True if the check is enabled at the moment

isProtectedObjectCheckEnabled

public boolean isProtectedObjectCheckEnabled()

Description copied from interface: ICheckSettings

Reads the protected object check mode enablement status

Specified by:

isProtectedObjectCheckEnabled in interface ICheckSettings

Returns:

True if the protected object check mode is enabled

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: ICheckSettings

Sets check enabling.

Specified by:

setEnabled in interface ICheckSettings

Parameters:

enabled - check enabling

setSeverity

public void setSeverity(IssueSeverity severity)

Description copied from interface: ICheckSettings

Sets check severity.

Specified by:

setSeverity in interface ICheckSettings

Parameters:

severity - check severity, not null

toString

public String toString()

Overrides:

toString in class Object