io.jmix.ui.settings

Class SettingsHelper

java.lang.Object

io.jmix.ui.settings.SettingsHelper

public final class SettingsHelper
extends java.lang.Object

Utility class for working with component settings.

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.google.gson.Gson	gson

Method Summary

Modifier and Type	Method and Description
static <T extends ComponentSettings> T	createSettings(java.lang.Class<T> settingsClass) Creates instance of settings class.
static <T extends ComponentSettings> T	createSettings(java.lang.Class<T> settingsClass, java.lang.String id) Creates instance of settings class with provided id.
static <T extends ComponentSettings> T	toComponentSettings(java.lang.String settings, java.lang.Class<T> settingsClass) Converts JSON string representation of settings to POJO.
static java.lang.String	toSettingsString(ComponentSettings settings) Converts settings from POJO to JSON string representation.

Methods inherited from class java.lang.Object

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

Field Detail

gson

protected static final com.google.gson.Gson gson

Method Detail

createSettings

public static <T extends ComponentSettings> T createSettings(java.lang.Class<T> settingsClass)

Creates instance of settings class.

Type Parameters:

T - any settings class that extends ComponentSettings

Parameters:

settingsClass - class of component settings

Returns:

instance of component settings

createSettings

public static <T extends ComponentSettings> T createSettings(java.lang.Class<T> settingsClass,
                                                             @Nullable
                                                             java.lang.String id)

Creates instance of settings class with provided id.

Type Parameters:

T - any settings class that extends ComponentSettings

Parameters:

settingsClass - class of component settings

id - component id

Returns:

instance of component settings

toComponentSettings

@Nullable
public static <T extends ComponentSettings> T toComponentSettings(java.lang.String settings,
                                                                            java.lang.Class<T> settingsClass)

Converts JSON string representation of settings to POJO.

Type Parameters:

T - any settings class that extends ComponentSettings

Parameters:

settings - JSON string representation of settings

settingsClass - POJO class of settings

Returns:

instance of component settings

toSettingsString

public static java.lang.String toSettingsString(ComponentSettings settings)

Converts settings from POJO to JSON string representation.

Parameters:

settings - component settings

Returns:

JSON string representation of component settings