org.eclipse.microprofile.openapi.annotations.media.PatternProperty Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2024 Contributors to the Eclipse Foundation
 * 
 * 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.eclipse.microprofile.openapi.annotations.media;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * A regular expression and an associated schema.
 * 
 * Used with {@link Schema#patternProperties()}, properties with names that match {@link #regex()} must have values
 * which validate against {@link #schema()}.
 *
 * @see Schema#patternProperties()
 * @since 4.0
 */
@Target({})
@Retention(RetentionPolicy.RUNTIME)
public @interface PatternProperty {

    /**
     * A regular expression to match against property names.
     *
     * @return an ECMA-262 regular expression
     */
    String regex();

    /**
     * A schema that a property value must validate against
     *
     * @return a class used to generate a schema used to validate properties with names that match {@link #regex()}
     */
    Class schema();
}