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 Copyrighted [year] [name of copyright owner]".
013 *
014 * Copyright 2011-2015 ForgeRock AS.
015 */
016
017package org.forgerock.json;
018
019/**
020 * Interface for transforming JSON values. Applied during the construction of a JSON value,
021 * and is inherited (and applied) by its child values.
022 */
023public interface JsonTransformer {
024
025    /**
026     * Performs the transformation of the specified JSON value. If a transformation is not
027     * applicable, then this method <strong>must not</strong> modify the value.
028     *
029     * @param value the JSON value to be transformed.
030     * @throws JsonException if an exception occurred applying the transformation.
031     */
032    void transform(JsonValue value);
033}