001package ezvcard;
002
003import java.lang.annotation.Documented;
004import java.lang.annotation.Retention;
005import java.lang.annotation.RetentionPolicy;
006
007import ezvcard.parameter.VCardParameter;
008import ezvcard.property.VCardProperty;
009
010/*
011 Copyright (c) 2012-2023, Michael Angstadt
012 All rights reserved.
013
014 Redistribution and use in source and binary forms, with or without
015 modification, are permitted provided that the following conditions are met: 
016
017 1. Redistributions of source code must retain the above copyright notice, this
018 list of conditions and the following disclaimer. 
019 2. Redistributions in binary form must reproduce the above copyright notice,
020 this list of conditions and the following disclaimer in the documentation
021 and/or other materials provided with the distribution. 
022
023 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
024 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
025 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
026 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
027 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
028 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
029 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
030 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
031 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
032 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
033 */
034
035/**
036 * <p>
037 * Defines the vCard version(s) that support a property ({@link VCardProperty}
038 * class), parameter value ({@link VCardParameter} instance), or data type (
039 * {@link VCardDataType} instance). If this annotation is not present, then all
040 * versions are presumed to be supported.
041 * </p>
042 * <p>
043 * <b>Examples</b>
044 * </p>
045 * 
046 * <pre class="brush:java">
047 * {@literal @}SupportedVersions({ VCardVersion.V2_1, VCardVersion.V3_0 })
048 * public class Agent extends VCardProperty {
049 *   //...
050 * }
051 * 
052 * public class AddressType extends VCardParameter {
053 *   {@literal @}SupportedVersions({ VCardVersion.V2_1, VCardVersion.V3_0 })
054 *   public static final AddressType DOM = new AddressType("dom");
055 *   //...
056 * }
057 * 
058 * public class VCardDataType {
059 *   {@literal @}SupportedVersions(VCardVersion.V2_1)
060 *   public static final VCardDataType CONTENT_ID = new VCardDataType("content-id");
061 *   //...
062 * }
063 * </pre>
064 * @author Michael Angstadt
065 */
066@Documented
067@Retention(RetentionPolicy.RUNTIME)
068public @interface SupportedVersions {
069        VCardVersion[] value();
070}