com.softlayer.api.service.user.Preference Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation

API client for accessing the SoftLayer API

There is a newer version: 0.3.4

package com.softlayer.api.service.user;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.user.preference.Type;

/**
 * The SoftLayer_User_Preference data type contains a single user preference to a specific preference type. 
 *
 * @see SoftLayer_User_Preference
 */
@ApiType("SoftLayer_User_Preference")
public class Preference extends Entity {

    /**
     * Description of the user preference
     */
    @ApiProperty
    protected String description;

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    /**
     * Type of user preference
     */
    @ApiProperty
    protected Type type;

    public Type getType() {
        return type;
    }

    public void setType(Type type) {
        this.type = type;
    }

    /**
     * The users current preference value
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String value;

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        valueSpecified = true;
        this.value = value;
    }

    protected boolean valueSpecified;

    public boolean isValueSpecified() {
        return valueSpecified;
    }

    public void unsetValue() {
        value = null;
        valueSpecified = false;
    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public Mask description() {
            withLocalProperty("description");
            return this;
        }

        public com.softlayer.api.service.user.preference.Type.Mask type() {
            return withSubMask("type", com.softlayer.api.service.user.preference.Type.Mask.class);
        }

        public Mask value() {
            withLocalProperty("value");
            return this;
        }

    }

}