org.jdbi.v3.json.JsonMapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jdbi3-json Show documentation

Support for JSON column types. In addition to this module, a serialization module (jackson2, gson2, moshi) is required.

There is a newer version: 3.47.0

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jdbi.v3.json;

import java.lang.reflect.Type;

import org.jdbi.v3.core.config.ConfigRegistry;

/**
 * Deserializes JSON to Java objects, and serializes Java objects to JSON.
 *
 * Implement this interface and {@link JsonConfig#setJsonMapper(JsonMapper)} it
 * to be able to convert objects to/from JSON between your application and database.
 *
 * jdbi3-jackson2 and jdbi3-gson2 are readily available for this.
 */
public interface JsonMapper {
    @Deprecated // forRemoval=true
    default String toJson(Type type, Object value, ConfigRegistry config) {
        return forType(type, config).toJson(value, config);
    }
    @Deprecated // forRemoval=true
    default Object fromJson(Type type, String json, ConfigRegistry config) {
        return forType(type, config).fromJson(json, config);
    }

    TypedJsonMapper forType(Type type, ConfigRegistry config);

    interface TypedJsonMapper {
        String toJson(Object value, ConfigRegistry config);
        Object fromJson(String json, ConfigRegistry config);
    }
}