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
025/**
026 * Declares a field or method parameter should be converted to collection using the
027 * specified delimiter.
028 *
029 * @author Phillip Webb
030 * @since 2.0.0
031 */
032@Documented
033@Retention(RetentionPolicy.RUNTIME)
034@Target({ ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER,
035                ElementType.ANNOTATION_TYPE })
036public @interface Delimiter {
037
038        /**
039         * A delimiter value used to indicate that no delimiter is required and the result
040         * should be a single element containing the entire string.
041         */
042        String NONE = "";
043
044        /**
045         * The delimiter to use or {@code NONE} if the entire contents should be treated as a
046         * single element.
047         * @return the delimiter
048         */
049        String value();
050
051}