001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.marshall.cbor;
018
019import static java.lang.annotation.ElementType.*;
020import static java.lang.annotation.RetentionPolicy.*;
021
022import java.lang.annotation.*;
023
024import org.apache.juneau.marshall.*;
025
026/**
027 * Dynamically applies a {@link Cbor @Cbor} annotation to specified classes, methods, or fields.
028 *
029 * <p>
030 * This annotation separates the <b>targeting</b> concern ({@link #on()}/{@link #onClass()}) from the
031 * <b>content</b> concern ({@link #value()}), enabling {@link Cbor @Cbor} to be a pure data annotation
032 * without marshall-specific application machinery.
033 *
034 * <h5 class='section'>See Also:</h5><ul>
035 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/DynamicallyAppliedAnnotations">Dynamically Applied Annotations</a>
036 * </ul>
037 */
038@Documented
039@Target({ TYPE, METHOD })
040@Retention(RUNTIME)
041@Repeatable(CborApply.Array.class)
042@ContextApply(CborApplyAnnotation.Applier.class)
043public @interface CborApply {
044
045   /**
046    * The {@link Cbor @Cbor} annotation to apply.
047    *
048    * @return The annotation value.
049    */
050   Cbor value();
051
052   /**
053    * Dynamically apply this annotation to the specified classes/methods/fields.
054    *
055    * <h5 class='section'>See Also:</h5><ul>
056    *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/DynamicallyAppliedAnnotations">Dynamically Applied Annotations</a>
057    * </ul>
058    *
059    * @return The annotation value.
060    */
061   String[] on() default {};
062
063   /**
064    * Dynamically apply this annotation to the specified classes.
065    *
066    * <h5 class='section'>See Also:</h5><ul>
067    *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/DynamicallyAppliedAnnotations">Dynamically Applied Annotations</a>
068    * </ul>
069    *
070    * @return The annotation value.
071    */
072   Class<?>[] onClass() default {};
073
074   /**
075    * A collection of {@link CborApply @CborApply annotations}.
076    */
077   @Documented
078   @Target({ TYPE, METHOD })
079   @Retention(RUNTIME)
080   public @interface Array {
081
082      /**
083       * The child annotations.
084       *
085       * @return The annotation value.
086       */
087      CborApply[] value();
088   }
089}