TypedValueSet (javadoc 2024.12-174331 API)

All Superinterfaces:

Comparable<TypedValueSet>, TeamCityExtension

All Known Implementing Classes:

AgentArchitectureValueSet, JdkTypedValueSet, OperatingSystemValueSet
```
public interface TypedValueSet
extends TeamCityExtension, Comparable<TypedValueSet>
```
Represents a typed set of values for parameters.

See Also:

TeamCityExtension, Comparable

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default int`	`compareTo(TypedValueSet o)`
`String`	`getDescription()`	Retrieves the user-presentable description of the set.
`default Collection<String>`	`getKeywords()`	Retrieves the search keywords for the set.
`String`	`getShortDescription()`	Short description for use in dropdown lists and similar places.
`String`	`getType()`	Retrieves the type of the typed value set.
`Map<String,String>`	`getValues(SProject project)`	Retrieves the possible values for a given project.

- Method Detail
  - getType
```
@NotNull
String getType()
```
    Retrieves the type of the typed value set. The type must be unique among all typed value sets.
    
    Returns:
    
    type of the value set
  - getKeywords
```
@NotNull
default Collection<String> getKeywords()
```
    Retrieves the search keywords for the set. These keywords assist in finding the appropriate set.
    
    Returns:
    
    collection of search keywords
  - getDescription
```
@NotNull
String getDescription()
```
    Retrieves the user-presentable description of the set.
    
    Returns:
    
    description.
  - getShortDescription
```
@Nullable
String getShortDescription()
```
    Short description for use in dropdown lists and similar places.
  - getValues
```
@NotNull
Map<String,String> getValues(@NotNull
                                   SProject project)
```
    Retrieves the possible values for a given project. This method returns a map where the key represents the actual value that can be used, and the value represents the display value that can be shown to the user.
    
    Parameters:
    
    project - The project context for which to retrieve the values.
    
    Returns:
    
    map of possible values. The map's key is the actual value, and the map's value is the display value.
  - compareTo
```
default int compareTo(@NotNull
                      TypedValueSet o)
```
    Specified by:
    
    compareTo in interface Comparable<TypedValueSet>