Package com.microsoft.semantickernel.contextvariables.converters

Class StringVariableContextVariableTypeConverter

java.lang.Object

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

com.microsoft.semantickernel.contextvariables.converters.StringVariableContextVariableTypeConverter

public class StringVariableContextVariableTypeConverter
extends ContextVariableTypeConverter<String>

A ContextVariableTypeConverter for java.lang.String variables. Use ContextVariableTypes.getGlobalVariableTypeForClass(String.class) to get an instance of this class.

See Also:

ContextVariableTypes.getGlobalVariableTypeForClass(Class)

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor	Description
StringVariableContextVariableTypeConverter()	Creates a new instance of the StringVariableContextVariableTypeConverter class.

Method Summary

Modifier and Type	Method	Description
static String	convertToString(Object s)	Converts the specified object to a string.

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

builder, escapeXmlString, fromObject, fromPromptString, getType, toObject, toObject, toPromptString

Methods inherited from class java.lang.Object

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

Constructor Detail

StringVariableContextVariableTypeConverter

public StringVariableContextVariableTypeConverter()

Creates a new instance of the StringVariableContextVariableTypeConverter class.

Method Detail

convertToString

@Nullable
public static String convertToString(@Nullable
                                     Object s)

Converts the specified object to a string. Has special handling for ContextVariable objects and for objects that look like an object reference

Parameters:

s - the object to convert

Returns:

the string representation of the object, or null if the object cannot be converted to a string or is an object reference.