Package com.sap.ai.sdk.grounding.model

Class KeyValueListPair

java.lang.Object

com.sap.ai.sdk.grounding.model.KeyValueListPair

public class KeyValueListPair
extends Object

KeyValueListPair

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KeyValueListPair.Builder	Builder helper class.
static interface	KeyValueListPair.Builder1	Builder helper class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KeyValueListPair()	Default constructor for KeyValueListPair.

Method Summary

Modifier and Type	Method	Description
KeyValueListPair	addValueItem(String valueItem)	Add one value instance to this KeyValueListPair.
static KeyValueListPair.Builder	create()	Create a type-safe, fluent-api builder object to construct a new KeyValueListPair instance with all required arguments.
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the KeyValueListPair.
String	getKey()	Get key
List<String>	getValue()	Get value
int	hashCode()
KeyValueListPair	key(String key)	Set the key of this KeyValueListPair instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this KeyValueListPair instance.
void	setKey(String key)	Set the key of this KeyValueListPair instance.
void	setValue(List<String> value)	Set the value of this KeyValueListPair instance.
Map<String,Object>	toMap()	Get the value of all properties of this KeyValueListPair instance including unrecognized properties.
String	toString()
KeyValueListPair	value(List<String> value)	Set the value of this KeyValueListPair instance and return the same instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

KeyValueListPair

protected KeyValueListPair()

Default constructor for KeyValueListPair.

Method Details

key

@Nonnull
public KeyValueListPair key(@Nonnull
 String key)

Set the key of this KeyValueListPair instance and return the same instance.

Parameters:

key - The key of this KeyValueListPair

Returns:

The same instance of this KeyValueListPair class

getKey

@Nonnull
public String getKey()

Get key

Returns:

key The key of this KeyValueListPair instance.

setKey

public void setKey(@Nonnull
 String key)

Set the key of this KeyValueListPair instance.

Parameters:

key - The key of this KeyValueListPair

value

@Nonnull
public KeyValueListPair value(@Nonnull
 List<String> value)

Set the value of this KeyValueListPair instance and return the same instance.

Parameters:

value - The value of this KeyValueListPair

Returns:

The same instance of this KeyValueListPair class

addValueItem

@Nonnull
public KeyValueListPair addValueItem(@Nonnull
 String valueItem)

Add one value instance to this KeyValueListPair.

Parameters:

valueItem - The value that should be added

Returns:

The same instance of type KeyValueListPair

getValue

@Nonnull
public List<String> getValue()

Get value

Returns:

value The value of this KeyValueListPair instance.

setValue

public void setValue(@Nonnull
 List<String> value)

Set the value of this KeyValueListPair instance.

Parameters:

value - The value of this KeyValueListPair

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the KeyValueListPair.

Returns:

The set of properties names

getCustomField

@Nullable
@Deprecated
public Object getCustomField(@Nonnull
 String name)
                      throws NoSuchElementException

Deprecated.

Use toMap() instead.

Get the value of an unrecognizable property of this KeyValueListPair instance.

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

NoSuchElementException - If no property with the given name could be found.

toMap

@Nonnull
public Map<String,Object> toMap()

Get the value of all properties of this KeyValueListPair instance including unrecognized properties.

Returns:

The map of all properties

setCustomField

public void setCustomField(@Nonnull
 String customFieldName,
 @Nullable
 Object customFieldValue)

Set an unrecognizable property of this KeyValueListPair instance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

customFieldName - The name of the property

customFieldValue - The value of the property

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

create

public static KeyValueListPair.Builder create()

Create a type-safe, fluent-api builder object to construct a new KeyValueListPair instance with all required arguments.