IQuantityCollection.java

/*****************************************************************************
 *  Limpet - the Lightweight InforMation ProcEssing Toolkit
 *  http://limpet.info
 *
 *  (C) 2015-2016, Deep Blue C Technologies Ltd
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the Eclipse Public License v1.0
 *  (http://www.eclipse.org/legal/epl-v10.html)
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *****************************************************************************/
package info.limpet;

import javax.measure.Measurable;
import javax.measure.quantity.Quantity;

public interface IQuantityCollection<Q extends Quantity> extends
    IObjectCollection<Measurable<Q>>, IBaseQuantityCollection<Q>
{
  /**
   * add a quantity, using the default units for this collection
   * 
   * @param value
   */
  void add(Number value);

  /**
   * if this collection just contains a single value, we allow that value to be changed in-place
   * 
   * @param newValue
   */
  void replaceSingleton(Number newValue);

  /**
   * if this collection just contains a single value, we allow that value to be retrieved
   * 
   * @return the single value
   */
  Number getSingletonValue();

  /**
   * allow the range of this collection to be specified
   * 
   * @param range
   */
  void setRange(QuantityRange<Q> range);

  /**
   * allow the range of this collection to be retrieved
   * 
   * @return range
   */
  QuantityRange<Q> getRange();
}