Package de.xima.fc.interfaces.workflow.value

Interface IBooleanValueDescriptor

All Superinterfaces:

IValueDescriptor<Boolean,IBooleanValueBuilder>, Serializable

public interface IBooleanValueDescriptor
extends IValueDescriptor<Boolean,IBooleanValueBuilder>

A IValueDescriptor for a boolean value. The value must be a boolean, either true or false.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IBooleanValueDescriptorBuilder	configure()	Creates a new builder pre-configured with the settings of this descriptor.
default EValueType	getBaseType()
default Class<?>	getJavaClass()
IBooleanValueDescriptor	withDefaultValue(Object defaultValue)
IBooleanValueDescriptor	withDescription(String description)

Methods inherited from interface de.xima.fc.interfaces.workflow.value.IValueDescriptor

acceptsValue, asAny, asBoolean, asConst, asFloat, asInteger, asLargeString, asList, asList, asMap, asMap, asNull, asRecord, asString, asTuple, asUnion, asUnion, asVoid, builder, getDefaultValue, getDescription, getFullType, getKnownProperties, getKnownProperties, intersect, is, unwrap

Method Detail

configure

IBooleanValueDescriptorBuilder configure()

Description copied from interface: IValueDescriptor

Creates a new builder pre-configured with the settings of this descriptor. Lets you e.g. add additional properties.

Specified by:

configure in interface IValueDescriptor<Boolean,IBooleanValueBuilder>

Returns:

A new builder pre-configured with the settings of this descriptor.

getBaseType

default EValueType getBaseType()

Specified by:

getBaseType in interface IValueDescriptor<Boolean,IBooleanValueBuilder>

Returns:

The basic type of value described by this value descriptor.

getJavaClass

default Class<?> getJavaClass()

Specified by:

getJavaClass in interface IValueDescriptor<Boolean,IBooleanValueBuilder>

Returns:

The Java class of the values described by this descriptor.

withDefaultValue

IBooleanValueDescriptor withDefaultValue(Object defaultValue)

Specified by:

withDefaultValue in interface IValueDescriptor<Boolean,IBooleanValueBuilder>

Parameters:

defaultValue - The new default value. May be changed when it does not conform to the restrictions imposed by this descriptor.

Returns:

A new descriptor with the default value.

withDescription

IBooleanValueDescriptor withDescription(String description)

Specified by:

withDescription in interface IValueDescriptor<Boolean,IBooleanValueBuilder>

Parameters:

description - The new description.

Returns:

A new descriptor with the given description.