com.github.victools.jsonschema.generator.CustomPropertyDefinitionProvider 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 7) 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;

/**
 * Provider of non-standard JSON schema definitions.
 *
 * @param  either field or method for which a custom definition may be provided
 */
public interface CustomPropertyDefinitionProvider> {

    /**
     * Look-up the non-standard JSON schema definition for a given property. If it returns null, the next definition provider is applied.
     *
     * @param scope targeted scope to provide custom definition for
     * @param context generation context allowing to let the standard generation take over nested parts of the custom definition
     * @return non-standard JSON schema definition (may be null)
     */
    CustomPropertyDefinition provideCustomSchemaDefinition(M scope, SchemaGenerationContext context);
}