001/*
002 * Units of Measurement Reference Implementation
003 * Copyright (c) 2005-2018, Jean-Marie Dautelle, Werner Keil, Otavio Santana.
004 *
005 * All rights reserved.
006 *
007 * Redistribution and use in source and binary forms, with or without modification,
008 * are permitted provided that the following conditions are met:
009 *
010 * 1. Redistributions of source code must retain the above copyright notice,
011 *    this list of conditions and the following disclaimer.
012 *
013 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
014 *    and the following disclaimer in the documentation and/or other materials provided with the distribution.
015 *
016 * 3. Neither the name of JSR-385, Indriya nor the names of their contributors may be used to endorse or promote products
017 *    derived from this software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
020 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
021 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
022 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
023 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
026 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
028 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package tech.units.indriya.spi;
031
032import static tech.units.indriya.spi.AbstractMeasurement.Default;
033
034import java.io.Serializable;
035import java.time.Instant;
036
037import javax.measure.Quantity;
038
039import tech.units.indriya.ComparableQuantity;
040import tech.uom.lib.common.function.QuantitySupplier;
041
042/**
043 * A Measurement contains a {@link Quantity} and a timestamp.
044 *
045 * <p>
046 * A {@code Measurement} object is used for maintaining the tuple of quantity and time-stamp.
047 * The value is represented as {@linkplain Quantity}
048 * and the time as {@linkplain Instant} plus <type>long</type> for backward-compatibility.
049 * <p>
050 *
051 * @see {@link QuantitySupplier}
052 * @author werner
053 * @version 0.7
054 * @param <Q>
055 * @since 1.0
056 */
057public interface Measurement<Q extends Quantity<Q>> extends QuantitySupplier<Q>, Serializable {
058
059        /**
060         * Returns the timestamp of this {@link Measurement}.
061         *
062         * @return a timestamp.
063         */
064        long getTimestamp();
065
066        /**
067         * Returns the {@linkplain Instant} as timestamp.
068         *
069         * @return an instant.
070         */
071        Instant getInstant();
072
073        @SuppressWarnings({ })
074        static <Q extends Quantity<Q>> Measurement<Q> of(Quantity<Q> q) {
075                return new Default<>(q);
076        }
077
078        static <Q extends Quantity<Q>> Measurement<Q> of(Quantity<Q> q, Instant i) {
079                return new Default<>(q, i);
080        }
081
082        static <Q extends Quantity<Q>> Measurement<Q> of(ComparableQuantity<Q> q) {
083                return new AbstractMeasurement.DefaultComparable<>(q);
084        }
085
086        static <Q extends Quantity<Q>> Measurement<Q> of(ComparableQuantity<Q> q, Instant i) {
087                return new AbstractMeasurement.DefaultComparable<>(q, i);
088        }
089}