com.mparticle.sdk.model.registration.Setting Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-sdk Show documentation
mParticle Java SDK used to integrate with mParticle's Firehose API
There is a newer version: 3.2.0
package com.mparticle.sdk.model.registration;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.mparticle.sdk.Utils;

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")
@JsonSubTypes({
        @JsonSubTypes.Type(name="text", value=TextSetting.class),
        @JsonSubTypes.Type(name="integer", value=IntegerSetting.class),
        @JsonSubTypes.Type(name="float", value=FloatSetting.class),
        @JsonSubTypes.Type(name="boolean", value=BooleanSetting.class)
})
public abstract class Setting {

    private final Type type;

    @JsonProperty(value="id", required=true)
    private String id;

    @JsonProperty(value="name", required=true)
    private String name;

    @JsonProperty("description")
    private String description;

    @JsonProperty("visible")
    private boolean isVisible;

    public Type getType() {
        return type;
    }

    public String getId() {
        return id;
    }

    public Setting setId(String id) {
        if (Utils.isNullOrEmpty(id)) throw new IllegalArgumentException();
        this.id = id;
        return this;
    }

    /**
     *
     * @return setting name
     */
    public String getName() {
        return name;
    }

    /**
     *
     * @param name setting name
     * @return this
     * @throws IllegalArgumentException
     */
    public Setting setName(String name) throws IllegalArgumentException {
        if (Utils.isNullOrEmpty(name)) throw new IllegalArgumentException();
        this.name = name;
        return this;
    }

    /**
     *
     * @return setting description
     */
    public String getDescription() {
        return description;
    }

    /**
     *
     * @param description  setting description
     * @return this
     */
    public Setting setDescription(String description) {
        this.description = description;
        return this;
    }

    /**
     *
     * @return true, if the setting is visible to users
     */
    public boolean isVisible() {
        return isVisible;
    }

    /**
     *
     * @param visible true, if the setting is visible to users
     * @return this
     */
    public Setting setIsVisible(boolean visible) {
        isVisible = visible;
        return this;
    }

    public Setting(Type type, String id, String name) {
        this.type = type;
        setId(id);
        setName(name);
        setIsVisible(true);
    }

    /**
     * Available setting types.
     */
    public enum Type {
        /**
         * Text setting
         */
        TEXT,
        /**
         * Integer setting
         */
        INTEGER,
        /**
         * Floating point setting
         */
        FLOAT,
        /**
         * Boolean setting
         */
        BOOLEAN;

        @Override
        public String toString() {
            return this.name().toLowerCase();
        }
    }
}