1 /*
2  * Copyright 2013 FasterXML.com
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License"); you may
5  * not use this file except in compliance with the License. You may obtain
6  * a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the license for the specific language governing permissions and
14  * limitations under the license.
15  */
16
17 package com.fasterxml.jackson.datatype.jsr310.ser;
18
19 import com.fasterxml.jackson.annotation.JsonFormat;
20 import com.fasterxml.jackson.core.JsonGenerator;
21 import com.fasterxml.jackson.core.JsonParser;
22 import com.fasterxml.jackson.core.JsonToken;
23
24 import com.fasterxml.jackson.databind.JavaType;
25 import com.fasterxml.jackson.databind.JsonMappingException;
26 import com.fasterxml.jackson.databind.SerializationFeature;
27 import com.fasterxml.jackson.databind.SerializerProvider;
28 import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper;
29 import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonIntegerFormatVisitor;
30 import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonValueFormat;
31 import com.fasterxml.jackson.datatype.jsr310.DecimalUtils;
32
33 import java.io.IOException;
34 import java.time.Duration;
35 import java.time.format.DateTimeFormatter;
36
37 /**
38  * Serializer for Java 8 temporal {@link Duration}s.
39  *<p>
40  * NOTE: since 2.10, {@link SerializationFeature#WRITE_DURATIONS_AS_TIMESTAMPS}
41  * determines global default used for determining if serialization should use
42  * numeric (timestamps) or textual representation. Before this,
43  * {@link SerializationFeature#WRITE_DATES_AS_TIMESTAMPS} was used.
44  *
45  * @author Nick Williams
46  * @since 2.2
47  */
48 public class DurationSerializer extends JSR310FormattedSerializerBase<Duration>
49 {
50     private static final long serialVersionUID = 1L;
51
52     public static final DurationSerializer INSTANCE = new DurationSerializer();
53
54     private DurationSerializer() {
55         super(Duration.class);
56     }
57
58     protected DurationSerializer(DurationSerializer base,
59             Boolean useTimestamp, DateTimeFormatter dtf) {
60         super(base, useTimestamp, dtf, null);
61     }
62
63     protected DurationSerializer(DurationSerializer base,
64             Boolean useTimestamp, Boolean useNanoseconds, DateTimeFormatter dtf) {
65         super(base, useTimestamp, useNanoseconds, dtf, null);
66     }
67
68     @Override
69     protected DurationSerializer withFormat(Boolean useTimestamp, DateTimeFormatter dtf, JsonFormat.Shape shape) {
70         return new DurationSerializer(this, useTimestamp, dtf);
71     }
72
73     // @since 2.10
74     @Override
75     protected SerializationFeature getTimestampsFeature() {
76         return SerializationFeature.WRITE_DURATIONS_AS_TIMESTAMPS;
77     }
78
79     @Override
80     public void serialize(Duration duration, JsonGenerator generator, SerializerProvider provider) throws IOException
81     {
82         if (useTimestamp(provider)) {
83             if (useNanoseconds(provider)) {
84                 generator.writeNumber(DecimalUtils.toBigDecimal(
85                         duration.getSeconds(), duration.getNano()
86                 ));
87             } else {
88                 generator.writeNumber(duration.toMillis());
89             }
90         } else {
91             // Does not look like we can make any use of DateTimeFormatter here?
92             generator.writeString(duration.toString());
93         }
94     }
95
96     @Override
97     protected void _acceptTimestampVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException
98     {
99         JsonIntegerFormatVisitor v2 = visitor.expectIntegerFormat(typeHint);
100         if (v2 != null) {
101             v2.numberType(JsonParser.NumberType.LONG);
102             SerializerProvider provider = visitor.getProvider();
103             if ((provider != null) && useNanoseconds(provider)) {
104                 // big number, no more specific qualifier to use...
105             } else { // otherwise good old Unix timestamp, in milliseconds
106                 v2.format(JsonValueFormat.UTC_MILLISEC);
107             }
108         }
109     }
110
111     @Override // since 2.9
112     protected JsonToken serializationShape(SerializerProvider provider) {
113         if (useTimestamp(provider)) {
114             if (useNanoseconds(provider)) {
115                 return JsonToken.VALUE_NUMBER_FLOAT;
116             }
117             return JsonToken.VALUE_NUMBER_INT;
118         }
119         return JsonToken.VALUE_STRING;
120     }
121
122     @Override
123     protected JSR310FormattedSerializerBase<?> withFeatures(Boolean writeZoneId, Boolean writeNanoseconds) {
124         return new DurationSerializer(this, _useTimestamp, writeNanoseconds, _formatter);
125     }
126 }
127