001/*
002 * Copyright 2012-2018 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.convert;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024import java.time.Duration;
025
026/**
027 * Annotation that can be used to indicate the format to use when converting a
028 * {@link Duration}.
029 *
030 * @author Phillip Webb
031 * @since 2.0.0
032 */
033@Target(ElementType.FIELD)
034@Retention(RetentionPolicy.RUNTIME)
035@Documented
036public @interface DurationFormat {
037
038        /**
039         * The duration format style.
040         * @return the duration format style.
041         */
042        DurationStyle value();
043
044}