1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.core.config.plugins.validation;
18
19 import java.lang.annotation.Annotation;
20
21 /**
22 * Interface that {@link Constraint} annotations must implement to perform validation logic.
23 *
24 * @param <A> the {@link Constraint} annotation this interface validates.
25 * @since 2.1
26 */
27 public interface ConstraintValidator<A extends Annotation> {
28
29 /**
30 * Called before this validator is used with the constraint annotation value.
31 *
32 * @param annotation the annotation value this validator will be validating.
33 */
34 void initialize(A annotation);
35
36 /**
37 * Indicates if the given value is valid.
38 *
39 * @param value the value to validate.
40 * @return {@code true} if the given value is valid.
41 */
42 boolean isValid(Object value);
43 }