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 */
016
017package org.forgerock.api.jackson;
018
019import java.io.IOException;
020
021/**
022 * Extension for CREST and OpenAPI schemas to express an example value.
023 *
024 * @param <T> The type of the example.
025 */
026public interface WithExampleSchema<T> {
027
028    /**
029     * Gets {@code example} JSON Schema field.
030     *
031     * @return The example value, or null if not defined.
032     */
033    T getExample();
034
035    /**
036     * Sets {@code example} JSON Schema field.
037     *
038     * @param example The example value.
039     * @throws IOException When the type of schema cannot be parsed from the String value.
040     */
041    void setExample(String example) throws IOException;
042}