com.arm.mbed.cloud.sdk.connect.model.Resource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mbed-cloud-sdk Show documentation
The Pelion Cloud SDK (formerly known as Mbed Cloud SDK) provides a simplified interface to the Pelion Cloud APIs by exposing functionality using conventions and paradigms familiar to Java developers.
There is a newer version: 2.5.0
Show newest version
package com.arm.mbed.cloud.sdk.connect.model;

import com.arm.mbed.cloud.sdk.annotations.DefaultValue;
import com.arm.mbed.cloud.sdk.annotations.Internal;
import com.arm.mbed.cloud.sdk.annotations.Preamble;
import com.arm.mbed.cloud.sdk.annotations.Required;
import com.arm.mbed.cloud.sdk.common.SdkModel;
import com.arm.mbed.cloud.sdk.devicedirectory.model.Device;

@Preamble(description = "Resource")
public class Resource implements SdkModel {
    /**
     * Serialisation Id.
     */
    private static final long serialVersionUID = 6360594606291188856L;
    /**
     * Related device ID.
     */
    @Required
    private String deviceId;
    /**
     * Resource's url.
     */
    @Required
    private String path;
    /**
     * Resource's type.
     */
    private final String type;
    /**
     * The content type of the resource.
     */
    private final String contentType;
    /**
     * Whether you can subscribe to changes for this resource.
     */
    @DefaultValue(value = "false")
    private final boolean observable;

    /**
     * Internal constructor.
     * 
     * Note: Should not be used. Use {@link #Resource(String, String)} instead.
     *
     * @param deviceId
     *            device id
     * @param path
     *            path
     * @param type
     *            type
     * @param contentType
     *            content type
     * @param observable
     *            observable
     */
    @Internal
    public Resource(String deviceId, String path, String type, String contentType, boolean observable) {
        super();
        setDeviceId(deviceId);
        setPath(path);
        this.type = type;
        this.contentType = contentType;
        this.observable = observable;
    }

    /**
     * Internal constructor.
     * 

     * Note: Should not be used. Use {@link #Resource(String, String)} instead.
     *
     * @param deviceId
     *            device id
     * @param path
     *            path
     * @param type
     *            type
     * @param contentType
     *            content type
     */
    @Internal
    public Resource(String deviceId, String path, String type, String contentType) {
        super();
        setDeviceId(deviceId);
        setPath(path);
        this.type = type;
        this.contentType = contentType;
        this.observable = false;
    }

    /**
     * Constructor.
     *
     * @param deviceId
     *            device id.
     * @param path
     *            resource path.
     */
    public Resource(String deviceId, String path) {
        this(deviceId, path, null, null);
    }

    /**
     * Constructor.
     *
     * @param device
     *            device.
     * @param path
     *            resource path.
     */
    public Resource(Device device, String path) {
        this((device == null) ? null : device.getId(), path);
    }

    /**
     * Constructor.
     */
    public Resource() {
        this(null, null, null, null);
    }

    /**
     * Gets device id.
     *
     * @return the deviceId
     */
    public String getDeviceId() {
        return deviceId;
    }

    /**
     * Sets device id.
     *
     * @param deviceId
     *            the deviceId to set
     */
    @Required
    public void setDeviceId(String deviceId) {
        this.deviceId = deviceId;
    }

    /**
     * Gets resource path.
     *
     * @return the path
     */
    public String getPath() {
        return path;
    }

    /**
     * Sets resource path.
     *
     * @param path
     *            the path to set
     */
    @Required
    public void setPath(String path) {
        this.path = path;
    }

    /**
     * Sets resource path.
     * 
     * Similar to {@link #setPath(String)}
     *
     * @param path
     *            the path to set
     */
    @Internal
    public void setResourcePath(String path) {
        setPath(path);
    }

    /**
     * Gets type.
     *
     * @return the type
     */
    public String getType() {
        return type;
    }

    /**
     * Gets content type.
     *
     * @return the contentType
     */
    public String getContentType() {
        return contentType;
    }

    /**
     * States whether you can subscribe to changes for this resource or
     * not (whether the resource is observable or not).
     *
     * @return the observable
     */
    public boolean isObservable() {
        return observable;
    }

    /**
     * Gets a clone.
     *
     * @return a clone
     *
     * @see java.lang.Object#clone()
     */
    @Override
    public Resource clone() throws CloneNotSupportedException {
        return new Resource(deviceId, path, type, contentType, observable);
    }

    /**
     * Determines whether all required fields have been set and therefore if the model instance is valid.
     *
     * @return true if instance is valid. False otherwise.
     */
    @Override
    public boolean isValid() {
        return deviceId != null && path != null;
    }

    /*
     * (non-Javadoc)
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return "Resource [deviceId=" + deviceId + ", path=" + path + ", type=" + type + ", contentType=" + contentType
                + ", observable=" + observable + "]";
    }

}