001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2016 ForgeRock AS.
015 * Partial Copyright 2021 Wren Security
016 */
017
018package org.forgerock.api.annotations;
019
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025/**
026 * Annotation to define JSON Schema {@code additionalProperties}, which is useful when working with key/value
027 * JSON data structures.
028 * <p>
029 * For example, the following JSON Schema defines a map from string (key) to string (value),
030 * </p>
031 * <pre>
032 * {
033 *   "type": "object",
034 *   "additionalProperties": {
035 *     "type": "string"
036 *   }
037 * }
038 * </pre>
039 * Note that keys are always strings in JSON, so the schema does not define that fact.
040 * <p>
041 * The annotation in this example would be used as follows,
042 * </p>
043 * <pre>
044 * &#064;AdditionalProperties(String.class)
045 * private static class MyMap extends HashMap&lt;String, String&gt; {}
046 * </pre>
047 */
048@Retention(RetentionPolicy.RUNTIME)
049@Target({ElementType.TYPE})
050public @interface AdditionalProperties {
051    /**
052     * The type to produce the additional-properties schema from.
053     */
054    Class<?> value() default Void.class;
055}