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

Interface IStringValueDescriptor

All Superinterfaces:

IValueDescriptor<String,IStringValueBuilder>, Serializable

public interface IStringValueDescriptor
extends IValueDescriptor<String,IStringValueBuilder>

A IValueDescriptor for string value. The value must be a string, consisting of any number of characters.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IStringValueDescriptorBuilder	configure()	Creates a new builder pre-configured with the settings of this descriptor.
default EValueType	getBaseType()
default Class<String>	getJavaClass()
IStringValueDescriptor	withDefaultValue(Object defaultValue)
IStringValueDescriptor	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

IStringValueDescriptorBuilder 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<String,IStringValueBuilder>

Returns:

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

getBaseType

default EValueType getBaseType()

Specified by:

getBaseType in interface IValueDescriptor<String,IStringValueBuilder>

Returns:

The basic type of value described by this value descriptor.

getJavaClass

default Class<String> getJavaClass()

Specified by:

getJavaClass in interface IValueDescriptor<String,IStringValueBuilder>

Returns:

The Java class of the values described by this descriptor.

withDefaultValue

IStringValueDescriptor withDefaultValue(Object defaultValue)

Specified by:

withDefaultValue in interface IValueDescriptor<String,IStringValueBuilder>

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

IStringValueDescriptor withDescription(String description)

Specified by:

withDescription in interface IValueDescriptor<String,IStringValueBuilder>

Parameters:

description - The new description.

Returns:

A new descriptor with the given description.