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;
024
025import org.springframework.util.unit.DataSize;
026import org.springframework.util.unit.DataUnit;
027
028/**
029 * Annotation that can be used to change the default unit used when converting a
030 * {@link DataSize}.
031 *
032 * @author Stephane Nicoll
033 * @since 2.1.0
034 */
035@Target(ElementType.FIELD)
036@Retention(RetentionPolicy.RUNTIME)
037@Documented
038public @interface DataSizeUnit {
039
040        /**
041         * The {@link DataUnit} to use if one is not specified.
042         * @return the data unit
043         */
044        DataUnit value();
045
046}