Interface IVoidValueDescriptor

All Superinterfaces:

IAttributeConfigurable<IValueDescriptor<Void, IVoidValueBuilder>>, IValueDescriptor<Void, IVoidValueBuilder>, Serializable

public interface IVoidValueDescriptor
extends IValueDescriptor<Void, IVoidValueBuilder>

A IValueDescriptor for a void value. The value must be identical to null.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
default boolean	acceptsValue(Object value, IValueAcceptanceCriteria criteria)	Tests whether the given value conforms to the restrictions imposed by this value descriptor.
default EValueType	getBaseType()	Gets the basic type of the value described by this value descriptor.
default Class<Void>	getJavaClass()	Gets the Java class of the values described by this descriptor.
default IVoidValueDescriptor	withAddedAttribute(String key, Object value)	Gets a new instance with the attribute at the given key changed to the given value.
default IVoidValueDescriptor	withAddedAttributes(Map<String,Object> newAttributes)	Gets a new instance with the attributes changed to the given map of attributes.
default IVoidValueDescriptor	withAttributes(Map<String,Object> attributes)	Gets a new instance with the attributes changed to the given map of attributes.
default IVoidValueDescriptor	withDefaultValue(Object defaultValue)	Gets a new value descriptor with the default value changed to the given value.
default IVoidValueDescriptor	withDescription(String description)	Deprecated.

Methods inherited from interface IAttributeConfigurable

getAttribute, getAttribute, getBooleanAttribute, getBooleanAttribute, getFloatAttribute, getFloatAttribute, getIntegerAttribute, getIntegerAttribute, getStringAttribute, getStringAttribute

Methods inherited from interface IValueDescriptor

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

Method Details

acceptsValue

default boolean acceptsValue(Object value,
 IValueAcceptanceCriteria criteria)

Description copied from interface: IValueDescriptor

Tests whether the given value conforms to the restrictions imposed by this value descriptor. Allows you to specify the acceptance criteria to check that control which restrictions are actually checked.

Specified by:

acceptsValue in interface IValueDescriptor<Void, IVoidValueBuilder>

Parameters:

value - A value to check.

Returns:

true when the given value conforms to the restrictions imposed by this value descriptor, false otherwise.

getBaseType

default EValueType getBaseType()

Description copied from interface: IValueDescriptor

Gets the basic type of the value described by this value descriptor.

Specified by:

getBaseType in interface IValueDescriptor<Void, IVoidValueBuilder>

Returns:

The value's basic type.

getJavaClass

default Class<Void> getJavaClass()

Description copied from interface: IValueDescriptor

Gets the Java class of the values described by this descriptor.

Specified by:

getJavaClass in interface IValueDescriptor<Void, IVoidValueBuilder>

Returns:

The value's Java class.

withAddedAttribute

default IVoidValueDescriptor withAddedAttribute(String key,
 Object value)

Description copied from interface: IAttributeConfigurable

Gets a new instance with the attribute at the given key changed to the given value.

Specified by:

withAddedAttribute in interface IAttributeConfigurable<IValueDescriptor<Void, IVoidValueBuilder>>

Parameters:

key - The attribute key.

value - The attribute value.

Returns:

A new instance with the new attribute.

withAddedAttributes

default IVoidValueDescriptor withAddedAttributes(Map<String,Object> newAttributes)

Description copied from interface: IAttributeConfigurable

Gets a new instance with the attributes changed to the given map of attributes. Preserves other existing attributes and only adds or replaces the given ones.

Specified by:

withAddedAttributes in interface IAttributeConfigurable<IValueDescriptor<Void, IVoidValueBuilder>>

Parameters:

newAttributes - The new attributes to add (or replace).

Returns:

A new instance with the current attributes plus the given attributes.

withAttributes

default IVoidValueDescriptor withAttributes(Map<String,Object> attributes)

Description copied from interface: IAttributeConfigurable

Gets a new instance with the attributes changed to the given map of attributes. Replaces all existing attributes.

Specified by:

withAttributes in interface IAttributeConfigurable<IValueDescriptor<Void, IVoidValueBuilder>>

Parameters:

attributes - The new attributes.

Returns:

A new instance with the given attributes.

withDefaultValue

default IVoidValueDescriptor withDefaultValue(Object defaultValue)

Description copied from interface: IValueDescriptor

Gets a new value descriptor with the default value changed to the given value.

Specified by:

withDefaultValue in interface IValueDescriptor<Void, IVoidValueBuilder>

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

@Deprecated
default IVoidValueDescriptor withDescription(String description)

Deprecated.

Description copied from interface: IValueDescriptor

Gets a new value descriptor with the description changed to the given description.

Specified by:

withDescription in interface IValueDescriptor<Void, IVoidValueBuilder>

Parameters:

description - The new description.

Returns:

A new descriptor with the given description.