com.github.victools.jsonschema.generator.InstanceAttributeOverrideV2 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsonschema-generator Show documentation

Java JSON Schema Generator – creating a JSON Schema (Draft 6, Draft 7 or Draft 2019-09) from your Java classes

There is a newer version: 4.37.0

/*
 * Copyright 2020 VicTools.
 *
 * 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 com.github.victools.jsonschema.generator;

import com.fasterxml.jackson.databind.node.ObjectNode;

/**
 * Entry point for customising the JSON Schema attributes being collected for a property.
 *
 * @param  type of the reference/context to modify
 */
public interface InstanceAttributeOverrideV2> {

    /**
     * Add/remove attributes on the given JSON Schema node – this is specifically intended for attributes relating to a particular instance.
     * 

     * E.g. {@link SchemaKeyword#TAG_DESCRIPTION}, {@link SchemaKeyword#TAG_MINIMUM}, {@link SchemaKeyword#TAG_MAXIMUM_EXCLUSIVE}
     *
     * @param collectedMemberAttributes node to modify
     * @param member reference/context to which the collected attributes in the JSON Schema node are referring
     * @param context generation context
     */
    void overrideInstanceAttributes(ObjectNode collectedMemberAttributes, M member, SchemaGenerationContext context);
}