Package org.incendo.cloud.annotations

Interface DescriptionMapper

@API(status=STABLE)
public interface DescriptionMapper

Method Summary

Modifier and Type	Method	Description
@NonNull Description	map(@NonNull String string)	Maps the given string to a Description.
static @NonNull DescriptionMapper	simple()	Returns a description mapper that maps the string to Description.of(String).

Method Details

simple

static @NonNull DescriptionMapper simple()

Returns a description mapper that maps the string to Description.of(String).

Returns:

the mapper

map

@NonNull Description map(@NonNull String string)

Maps the given string to a Description.

Parameters:

string - the string to map

Returns:

the description