johnzon-mapper/src/main/java/org/apache/johnzon/mapper/ObjectConverter.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.apache.johnzon.mapper;

import jakarta.json.JsonValue;

import java.lang.reflect.Type;

/**
 * Convert a given Java Type a nested JSON representation. And the other way
 * around.
 *
 * An example would be to convert a custom Project POJO, like Dog.class to it's
 * JSON representation
 *
 */
public final class ObjectConverter {
    private ObjectConverter() {
        // no-op
    }

    public interface Writer<T> extends MapperConverter {
        void writeJson(T instance, MappingGenerator jsonbGenerator);

        // returns true if it is for containers - if any - and not each container item (ex: list)
        default boolean isGlobal() {
            return false;
        }
    }

    public interface Reader<T> extends MapperConverter {
        T fromJson(JsonValue jsonValue, Type targetType, MappingParser parser);

        // returns true if it is for containers - if any - and not each container item (ex: list)
        default boolean isGlobal() {
            return false;
        }
    }

    public interface Codec<T> extends ObjectConverter.Writer<T>, ObjectConverter.Reader<T> {
        @Override
        default boolean isGlobal() {
            return false;
        }
    }
}