001    /**
002     * Copyright (C) 2009-2011 the original author or authors.
003     * See the notice.md file distributed with this work for additional
004     * information regarding copyright ownership.
005     *
006     * Licensed under the Apache License, Version 2.0 (the "License");
007     * you may not use this file except in compliance with the License.
008     * You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing, software
013     * distributed under the License is distributed on an "AS IS" BASIS,
014     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    
019    package org.codehaus.jackson.annotate;
020    
021    import java.lang.annotation.ElementType;
022    import java.lang.annotation.Retention;
023    import java.lang.annotation.RetentionPolicy;
024    import java.lang.annotation.Target;
025    
026    /**
027     * Annotation used with {@link JsonTypeInfo} to indicate sub types of serializable
028     * polymorphic types, and to associate logical names used within JSON content
029     * (which is more portable than using physical Java class names).
030     * 
031     * @since 1.5
032     */
033    @Target({ElementType.TYPE})
034    @Retention(RetentionPolicy.RUNTIME)
035    @JacksonAnnotation
036    public @interface JsonSubTypes {
037        /**
038         * Subtypes of the annotated type (annotated class, or property value type
039         * associated with the annotated method). These will be checked recursively
040         * so that types can be defined by only including direct subtypes.
041         */
042        public Type[] value();
043    
044        /**
045         * Definition of a subtype, along with optional name. If name is missing, class
046         * of the type will be checked for {@link JsonTypeName} annotation; and if that
047         * is also missing or empty, a default
048         * name will be constructed by type id mechanism.
049         * Default name is usually based on class name.
050         */
051        public @interface Type {
052            /**
053             * Class of the subtype
054             */
055            public Class<?> value();
056    
057            /**
058             * Logical type name used as the type identifier for the class
059             */
060            public String name() default "";
061        }
062    }