com.puresoltechnologies.commons.domain.Value Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of domain Show documentation

The newest version!

package com.puresoltechnologies.commons.domain;

import java.io.Serializable;

import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonTypeInfo.As;
import com.fasterxml.jackson.annotation.JsonTypeInfo.Id;

/**
 * 
 * This interface represents a value. A value always consists of two parts:
 * 
 * 
 * A value which represents a measurement or state.
 * A parameter of type {@link Parameter} which specifies which kind of value
 * it is.
 * 
 * 
 * @author Rick-Rainer Ludwig
 * 
 * @param 
 *            is the type of the value to be stored.
 */
@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY, property = "class")
public interface Value extends Serializable {

    /**
     * This method returns the stored value.
     * 
     * @return An object of type T is returned.
     */
    public T getValue();

    /**
     * This method returns the corresponding parameter.
     * 
     * @return An object of type {@link Parameter} is returned.
     */
    public Parameter getParameter();
}