UnitAdapter.java

  1. package org.opentrafficsim.xml.bindings;

  2. import javax.xml.bind.annotation.adapters.XmlAdapter;

  3. import org.djunits.value.vdouble.scalar.base.DoubleScalarInterface;
  4. import org.djutils.exceptions.Throw;

  5. /**
  6.  * UnitAdapter is the generic class for all Unit-based XML-adapters.
  7.  * <p>
  8.  * Copyright (c) 2019-2022 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
  9.  * BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>.
  10.  * <p>
  11.  * @author <a href="https://www.tudelft.nl/averbraeck" target="_blank">Alexander Verbraeck</a>
  12.  */
  13. public abstract class UnitAdapter<S extends DoubleScalarInterface<?, S>> extends XmlAdapter<String, S>
  14. {
  15.     /** {@inheritDoc} */
  16.     @Override
  17.     public String marshal(final S scalar)
  18.     {
  19.         Throw.whenNull(scalar, "Marshalling scalar with unit: argument contains null value");
  20.         return scalar.getInUnit() + " " + scalar.getDisplayUnit().getDefaultTextualAbbreviation();
  21.     }

  22. }