Package com.day.cq.dam.scene7.api.model

Class Scene7ConfigSetting

java.lang.Object

com.day.cq.dam.scene7.api.model.Scene7ConfigSetting

public class Scene7ConfigSetting
extends Object

A viewer configuration setting Return values and parameters are @NotNull by default.

Constructor Summary

Constructors

Constructor	Description
Scene7ConfigSetting(String name, @Nullable String value, @Nullable String handle)	Create a new viewer preset

Method Summary

Modifier and Type	Method	Description
@Nullable String	getHandle()	Retrieve the handle to the stored configuration
String	getName()	Retrieve the name of the preset
@Nullable String	getValue()	Retrieve the value of the preset

Methods inherited from class java.lang.Object

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

Constructor Detail

Scene7ConfigSetting

public Scene7ConfigSetting(String name,
                           @Nullable
                           @Nullable String value,
                           @Nullable
                           @Nullable String handle)

Create a new viewer preset

Parameters:

name - name of the preset

value - (optional) value of the preset

handle - (optional) handle to the stored config

Method Detail

getName

public String getName()

Retrieve the name of the preset

Returns:

The preset name

getValue

@Nullable
public @Nullable String getValue()

Retrieve the value of the preset

Returns:

The preset value

getHandle

@Nullable
public @Nullable String getHandle()

Retrieve the handle to the stored configuration

Returns:

The optional handle value, might be null