001/* 002 * Units of Measurement Implementation for Java SE 003 * Copyright (c) 2005-2017, Jean-Marie Dautelle, Werner Keil, V2COM. 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-363 nor the names of its 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 tec.uom.se.spi; 031 032import static tec.uom.se.spi.AbstractMeasurement.Default; 033 034import java.io.Serializable; 035import java.time.Instant; 036 037import javax.measure.Quantity; 038 039import tec.uom.lib.common.function.QuantitySupplier; 040import tec.uom.se.ComparableQuantity; 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.6 054 * @param <Q> 055 */ 056public interface Measurement<Q extends Quantity<Q>> extends QuantitySupplier<Q>, Serializable { 057 058 /** 059 * Returns the timestamp of this {@link Measurement}. 060 * 061 * @return a timestamp. 062 */ 063 long getTimestamp(); 064 065 /** 066 * Returns the {@linkplain Instant} as timestamp. 067 * 068 * @return an instant. 069 */ 070 Instant getInstant(); 071 072 @SuppressWarnings({ }) 073 static <Q extends Quantity<Q>> Measurement<Q> of(Quantity<Q> q) { 074 return new Default<>(q); 075 } 076 077 static <Q extends Quantity<Q>> Measurement<Q> of(Quantity<Q> q, Instant i) { 078 return new Default<>(q, i); 079 } 080 081 static <Q extends Quantity<Q>> Measurement<Q> of(ComparableQuantity<Q> q) { 082 return new AbstractMeasurement.DefaultComparable<>(q); 083 } 084 085 static <Q extends Quantity<Q>> Measurement<Q> of(ComparableQuantity<Q> q, Instant i) { 086 return new AbstractMeasurement.DefaultComparable<>(q, i); 087 } 088}