io.openapiprocessor.jsonschema.converter.PropertyConverter Maven / Gradle / Ivy

Go to download

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

OpenAPI Parser JSON-Schema Validator

There is a newer version: 2024.4

Show newest version

/*
 * Copyright 2021 https://github.com/openapi-processor/openapi-parser
 * PDX-License-Identifier: Apache-2.0
 */

package io.openapiprocessor.jsonschema.converter;

import io.openapiprocessor.jsonschema.schema.JsonPointer;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * convert {@code Object} value to {@code T}.
 *
 * @param  target type.
 */
public interface PropertyConverter {
    /**
     * converts the {@code value} of a property to a {@code T} object or null. May throw if
     * conversion fails, e.g. if the property is required but null.
     *
     * @param name  property name
     * @param value property value
     * @param location property location, json pointer
     * @return T converted value
     */
    @Nullable T convert (String name, @Nullable Object value, String location);

    default @Nullable T convert (String name, @Nullable Object value, JsonPointer location) {
        return convert (name, value, location.toString ());
    }
}