Module dev.metaschema.core

Package dev.metaschema.core.model.constraint

Class AbstractConfigurableMessageConstraintBuilder<T extends AbstractConfigurableMessageConstraintBuilder<T,R>,R extends IConfigurableMessageConstraint>

java.lang.Object

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

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

Type Parameters:

T - the Java type of the implementing builder

R - the Java type of the resulting built object

Direct Known Subclasses:

AbstractKeyConstraintBuilder, ICardinalityConstraint.Builder, IExpectConstraint.Builder, IMatchesConstraint.Builder, IReportConstraint.Builder

public abstract class AbstractConfigurableMessageConstraintBuilder<T extends AbstractConfigurableMessageConstraintBuilder<T,R>,R extends IConfigurableMessageConstraint>
extends AbstractConstraintBuilder<T,R>

Provides builder methods for the core data elements of an IConstraint.

The base class of all constraint builders.

Since:

2.0.0

Constructor Summary

Constructors

Constructor	Description
AbstractConfigurableMessageConstraintBuilder()

Method Summary

Modifier and Type	Method	Description
protected String	getMessage()	Get the constraint message provided to the builder.
T	message(String message)	A message to emit when the constraint is violated.

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

build, description, formalName, getDescription, getFormalName, getId, getLevel, getProperties, getRemarks, getSource, getTarget, getThis, identifier, level, newInstance, properties, property, property, remarks, source, target, validate

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractConfigurableMessageConstraintBuilder

public AbstractConfigurableMessageConstraintBuilder()

Method Details

message

@NonNull
public T message(@NonNull
 String message)

A message to emit when the constraint is violated. Allows embedded Metapath expressions using the syntax \{ metapath \}.

Parameters:

message - the message if defined or null otherwise

Returns:

this builder

getMessage

@Nullable
protected String getMessage()

Get the constraint message provided to the builder.

Returns:

the message or null if no message is set