001/*
002 *  Units of Measurement Jackson Library for JSON support
003 *  Copyright (c) 2012-2019, Werner Keil and others
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, Units of Measurement 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.uom.lib.jackson;
031
032import com.fasterxml.jackson.core.JsonGenerator;
033import com.fasterxml.jackson.databind.JsonSerializer;
034import com.fasterxml.jackson.databind.SerializerProvider;
035import com.fasterxml.jackson.databind.ser.std.StdScalarSerializer;
036import java.io.IOException;
037import javax.measure.Dimension;
038
039/**
040 *
041 * @author richter
042 */
043public class DimensionJsonSerializer extends StdScalarSerializer<Dimension> {
044
045    /**
046         * 
047         */
048        private static final long serialVersionUID = 1L;
049
050        public DimensionJsonSerializer() {
051        super(Dimension.class);
052    }
053
054    /**
055     * Serializes a dimension by serializing it's base dimension map.
056     *
057     * Based on my question and answer at
058     * https://stackoverflow.com/questions/48509189/jsr-275-dimension-string-serialization-and-deserialization
059     * which might contain better alternatives meanwhile.
060     *
061     * @param value       the dimension to serialize
062     * @param gen         the generator as provided by {@link JsonSerializer}
063     * @param serializers the serializers as provided by {@link JsonSerializer}
064     * @throws IOException if an I/O exception occurs
065     */
066    @Override
067    public void serialize(Dimension value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
068        gen.writeObject(value.getBaseDimensions());
069    }
070}