java.lang.Object
- com.e1c.g5.v8.dt.check.components.BasicCheck.CheckParameterBuilder

Enclosing class:

BasicCheck
```
public static final class BasicCheck.CheckParameterBuilder
extends Object
```
Check parameter builder. Defines the context of the check parameters definition. See documentation of methods for the usage instructions. This builder is not intended for the direct creation by check developers

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BasicCheck.CheckConfigurer`	`complexity(CheckComplexity complexity)`	Defines the complexity of the check.
`BasicCheck.CheckParameterBuilder`	`description(String description)`	Sets the simple description for the check.
`BasicCheck.CheckParameterBuilder`	`issueType(IssueType issueType)`	Defines the type of issues provided by this check
`BasicCheck.ModuleConfigurationBuilder`	`module()`	Declares the participation of the check into the language module check process.
`BasicCheck.CheckParameterBuilder`	`parameter(String name, Class<?> type, String defaultValue, String title)`	Defines a parameter of the check.
`BasicCheck.CheckConfigurer`	`severity(IssueSeverity severity)`	Defines the default severity of issues provided by this check
`BasicCheck.CheckConfigurer`	`title(String title)`	Defines the check title.
`BasicCheck.TopObjectConfigurationBuilder`	`topObject(org.eclipse.emf.ecore.EClass topObjectEClass)`	Defines the check running rule on change of model top object data.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - complexity
```
public BasicCheck.CheckConfigurer complexity(CheckComplexity complexity)
```
    Defines the complexity of the check. The check subsystem takes this setting into the account while planning the check process to achieve maximum operativeness of checks
    
    Parameters:
    
    complexity - The complexity to set. May not be null
    
    Returns:
    
    The BasicCheck.CheckConfigurer for configuration chaining. May not be null
  - description
```
public BasicCheck.CheckParameterBuilder description(String description)
```
    Sets the simple description for the check. This description may be overriden by the external description definition for the check (if defined), see the ICheck description for details and typically is used as a fallback for non-supported languages
    
    Parameters:
    
    description - The description to set. May not be null
    
    Returns:
    
    The BasicCheck.CheckConfigurer for configuration chaining. May not be null
  - issueType
```
public BasicCheck.CheckParameterBuilder issueType(IssueType issueType)
```
    Defines the type of issues provided by this check
    
    Parameters:
    
    issueType - The type to set. May not be null
    
    Returns:
    
    The BasicCheck.CheckConfigurer for configuration chaining. May not be null
  - module
```
public BasicCheck.ModuleConfigurationBuilder module()
```
    Declares the participation of the check into the language module check process. Use the returned builder to configure details of the check pariticipation. See BasicCheck.ModuleConfigurationBuilder for details
    
    Returns:
    
    The BasicCheck.ModuleConfigurationBuilder for the further configuration. Never null
  - parameter
```
public BasicCheck.CheckParameterBuilder parameter(String name,
                                                  Class<?> type,
                                                  String defaultValue,
                                                  String title)
```
    Defines a parameter of the check. The parameter will be available on the check preferences page for the editing and its value will be accessible during the check via the ICheckParameters Example: add Integer parameter to the check:
    ...
    builder.topObject(CATALOG).
    MIN_LENGTH_PARAMETER_NAME, Integer.class, "8", Messages.CatalogCodeLengthCheck_MinLengthParameter_Title).
    ...
    Parameters:
    
    name - The name of the parameter. May not be null. Must be unique among other parameters being defined for this check. In case if the name is not unqiue any arbitrary parameter definition may be selected as final parameter definition
    
    type - The type of the parameter. May not be null. The following set of the parameter types are supported:
    
    Boolean - supported values are: True, False, TRUE, FALSE
    
    Integer - matches requirements of the Integer.valueOf(String)
    
    Long - - matches requirements of the Long.valueOf(String)
    
    Double - supports dot separated format (XXXX.YYYY)
    
    String - any generic string
    
    defaultValue - The default value (as String). May be null or empty. See the type parameter for the available values.
    
    title - The title of the parameter to display to the user in the check preferences page. May be null or empty
    
    Returns:
    
    The BasicCheck.CheckParameterBuilder for configuration chaining. May not be null
  - severity
```
public BasicCheck.CheckConfigurer severity(IssueSeverity severity)
```
    Defines the default severity of issues provided by this check
    
    Parameters:
    
    severity - The severity to set. May not be null
    
    Returns:
    
    The BasicCheck.CheckConfigurer for configuration chaining. May not be null
  - title
```
public BasicCheck.CheckConfigurer title(String title)
```
    Defines the check title. The title is being displayed in the check tree for easier navigation
    
    Parameters:
    
    title - The title to set. May not be null
    
    Returns:
    
    The BasicCheck.CheckConfigurer for configuration chaining. May not be null
  - topObject
```
public BasicCheck.TopObjectConfigurationBuilder topObject(org.eclipse.emf.ecore.EClass topObjectEClass)
```
    Defines the check running rule on change of model top object data. The object is defined by the corresponding EClass.
    The rest of check launching configuration for this object should be done via the object being returned by this method
    
    Example: Start the configuration of check running rules for the Catalog object:
    ...
    builder.topObject(CATALOG).
    ... Please note, that calling of this method will effectively finish the configuration of the currently selected top object and begins the configuration of a new one. It's impossible to proceed with the configuration of the previous top object after the call of this method
    
    Parameters:
    
    topObjectEClass - The EClass of the target top object. May not be null
    
    Returns:
    
    BasicCheck.TopObjectConfigurationBuilder bound to the context of the selected EClass and ready for further configuration. May not be null

Class BasicCheck.CheckParameterBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

complexity

description

issueType

module

parameter

severity

title

topObject