Module dev.metaschema.core

Package dev.metaschema.core.model.constraint

Class IAllowedValuesConstraint.Builder

java.lang.Object

dev.metaschema.core.model.constraint.AbstractConstraintBuilder<IAllowedValuesConstraint.Builder,IAllowedValuesConstraint>

dev.metaschema.core.model.constraint.IAllowedValuesConstraint.Builder

Enclosing interface:

IAllowedValuesConstraint

public static final class IAllowedValuesConstraint.Builder
extends AbstractConstraintBuilder<IAllowedValuesConstraint.Builder,IAllowedValuesConstraint>

Provides a builder pattern for constructing a new IAllowedValuesConstraint.

Method Summary

Modifier and Type	Method	Description
IAllowedValuesConstraint.Builder	allowedValue(IAllowedValue allowedValue)	Use the provided allowed value to validate associated values.
IAllowedValuesConstraint.Builder	allowedValues(Map<String,IAllowedValue> allowedValues)	Use the provided allowed values to validate associated values.
IAllowedValuesConstraint.Builder	allowsOther(boolean bool)	Determine if unspecified values are allowed and will result in the constraint always passing.
IAllowedValuesConstraint.Builder	extensible(IAllowedValuesConstraint.Extensible extensible)	Determine the allowed scope of extension for other constraints matching this constraint's target.
protected IAllowedValuesConstraint.Builder	getThis()	Get the builder.
protected IAllowedValuesConstraint	newInstance()	Get a new instance of the built object.

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

build, description, formalName, getDescription, getFormalName, getId, getLevel, getProperties, getRemarks, getSource, getTarget, identifier, level, 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

Method Details

allowedValue

@NonNull
public IAllowedValuesConstraint.Builder allowedValue(@NonNull
 IAllowedValue allowedValue)

Use the provided allowed value to validate associated values.

Parameters:

allowedValue - an expected allowed value

Returns:

this builder

allowedValues

@NonNull
public IAllowedValuesConstraint.Builder allowedValues(@NonNull
 Map<String,IAllowedValue> allowedValues)

Use the provided allowed values to validate associated values.

Parameters:

allowedValues - an expected allowed values

Returns:

this builder

allowsOther

@NonNull
public IAllowedValuesConstraint.Builder allowsOther(boolean bool)

Determine if unspecified values are allowed and will result in the constraint always passing.

Parameters:

bool - true if other values are allowed or false otherwise

Returns:

this builder

extensible

@NonNull
public IAllowedValuesConstraint.Builder extensible(@NonNull
 IAllowedValuesConstraint.Extensible extensible)

Determine the allowed scope of extension for other constraints matching this constraint's target.

Parameters:

extensible - the degree of allowed extension

Returns:

this builder

getThis

protected IAllowedValuesConstraint.Builder getThis()

Description copied from class: AbstractConstraintBuilder

Get the builder.

Implementations of this method must return this.

Specified by:

getThis in class AbstractConstraintBuilder<IAllowedValuesConstraint.Builder,IAllowedValuesConstraint>

Returns:

the builder instance

newInstance

protected IAllowedValuesConstraint newInstance()

Description copied from class: AbstractConstraintBuilder

Get a new instance of the built object.

Specified by:

newInstance in class AbstractConstraintBuilder<IAllowedValuesConstraint.Builder,IAllowedValuesConstraint>

Returns:

the built instance