Module dev.metaschema.core

Package dev.metaschema.core.model.constraint

Class IReportConstraint.Builder

java.lang.Object

dev.metaschema.core.model.constraint.AbstractConstraintBuilder<T,R>

dev.metaschema.core.model.constraint.AbstractConfigurableMessageConstraintBuilder<IReportConstraint.Builder,IReportConstraint>

dev.metaschema.core.model.constraint.IReportConstraint.Builder

Enclosing interface:

IReportConstraint

public static final class IReportConstraint.Builder
extends AbstractConfigurableMessageConstraintBuilder<IReportConstraint.Builder,IReportConstraint>

Provides a builder pattern for constructing a new IReportConstraint.

Method Summary

Modifier and Type	Method	Description
protected IConstraint.Level	getLevel()	Get the constraint severity level provided to the builder.
protected IReportConstraint.Builder	getThis()	Get the builder.
IReportConstraint.Builder	level(IConstraint.Level level)	Set the severity level for when the constraint is violated.
protected IReportConstraint	newInstance()	Get a new instance of the built object.
IReportConstraint.Builder	test(IMetapathExpression test)	Use the provided test to identify reportable conditions in selected nodes.
protected void	validate()	Validate the values provided to the builder.

Methods inherited from class dev.metaschema.core.model.constraint.AbstractConfigurableMessageConstraintBuilder

getMessage, message

Methods inherited from class dev.metaschema.core.model.constraint.AbstractConstraintBuilder

build, description, formalName, getDescription, getFormalName, getId, getProperties, getRemarks, getSource, getTarget, identifier, properties, property, property, remarks, source, target

Methods inherited from class java.lang.Object

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

Method Details

test

@NonNull
public IReportConstraint.Builder test(@NonNull
 IMetapathExpression test)

Use the provided test to identify reportable conditions in selected nodes.

A finding is generated when this test evaluates to true.

Parameters:

test - the test metapath expression to use

Returns:

this builder

getThis

protected IReportConstraint.Builder getThis()

Description copied from class: AbstractConstraintBuilder

Get the builder.

Implementations of this method must return this.

Specified by:

getThis in class AbstractConstraintBuilder<IReportConstraint.Builder,IReportConstraint>

Returns:

the builder instance

level

@NonNull
public IReportConstraint.Builder level(@NonNull
 IConstraint.Level level)

Set the severity level for when the constraint is violated.

For report constraints, the default level is IConstraint.Level.INFORMATIONAL if no level is explicitly set.

Overrides:

level in class AbstractConstraintBuilder<IReportConstraint.Builder,IReportConstraint>

Parameters:

level - the level to set

Returns:

this builder

getLevel

@NonNull
protected IConstraint.Level getLevel()

Description copied from class: AbstractConstraintBuilder

Get the constraint severity level provided to the builder.

Overrides:

getLevel in class AbstractConstraintBuilder<IReportConstraint.Builder,IReportConstraint>

Returns:

the severity level

validate

protected void validate()

Description copied from class: AbstractConstraintBuilder

Validate the values provided to the builder.

Overrides:

validate in class AbstractConstraintBuilder<IReportConstraint.Builder,IReportConstraint>

newInstance

protected IReportConstraint newInstance()

Description copied from class: AbstractConstraintBuilder

Get a new instance of the built object.

Specified by:

newInstance in class AbstractConstraintBuilder<IReportConstraint.Builder,IReportConstraint>

Returns:

the built instance