Package com.microsoft.semantickernel.contextvariables.converters

Class NumberVariableContextVariableTypeConverter<T extends Number>

java.lang.Object

com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter<T>

com.microsoft.semantickernel.contextvariables.converters.NumberVariableContextVariableTypeConverter<T>

Type Parameters:

T - the type of the number

public class NumberVariableContextVariableTypeConverter<T extends Number>
extends ContextVariableTypeConverter<T>

A ContextVariableTypeConverter for java.lang.Number type variables. Use, for example, ContextVariableTypes.getGlobalVariableTypeForClass(Integer.class) to get an instance of this class that works with the Integer type.

See Also:

ContextVariableTypes.getGlobalVariableTypeForClass(Class)

Nested Class Summary

Nested classes/interfaces inherited from class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter

ContextVariableTypeConverter.Converter<T,U>, ContextVariableTypeConverter.DefaultConverter<T,U>, ContextVariableTypeConverter.NoopConverter<T>

Constructor Summary

Constructors

Constructor	Description
NumberVariableContextVariableTypeConverter(Class<T> clazz, Function<String,T> fromPromptString, Function<Number,T> fromNumber)	Creates a new instance of the NumberVariableContextVariableTypeConverter class.

Method Summary

Modifier and Type	Method	Description
T	fromObject(Object s)	Convert the object to the type of the context variable using the fromObject function provided to the constructor.
T	fromPromptString(String s)	Convert the prompt string to the type using the fromPromptString function provided to the constructor.
<U> U	toObject(Object t, Class<U> clazz)	Use this converter to convert the object to the type of the context variable.

Methods inherited from class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter

getType, toPromptString

Methods inherited from class java.lang.Object

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

Constructor Detail

NumberVariableContextVariableTypeConverter

public NumberVariableContextVariableTypeConverter(Class<T> clazz,
                                                  Function<String,T> fromPromptString,
                                                  Function<Number,T> fromNumber)

Creates a new instance of the NumberVariableContextVariableTypeConverter class.

Parameters:

clazz - the class

fromPromptString - the function to convert from a prompt string

fromNumber - the function to convert from a number

Method Detail

toObject

@Nullable
public <U> U toObject(@Nullable
                      Object t,
                      Class<U> clazz)

Description copied from class: ContextVariableTypeConverter

Use this converter to convert the object to the type of the context variable.

Overrides:

toObject in class ContextVariableTypeConverter<T extends Number>

Type Parameters:

U - the type to convert to

Parameters:

t - the object to convert

clazz - the class of the type to convert to

Returns:

the converted object

fromObject

@Nullable
public T fromObject(@Nullable
                    Object s)

Description copied from class: ContextVariableTypeConverter

Convert the object to the type of the context variable using the fromObject function provided to the constructor.

Overrides:

fromObject in class ContextVariableTypeConverter<T extends Number>

Parameters:

s - the object to convert

Returns:

the converted object

fromPromptString

@Nullable
public T fromPromptString(@Nullable
                          String s)

Description copied from class: ContextVariableTypeConverter

Convert the prompt string to the type using the fromPromptString function provided to the constructor.

Overrides:

fromPromptString in class ContextVariableTypeConverter<T extends Number>

Parameters:

s - the prompt string to convert

Returns:

the type