1 package org.apache.onami.validation;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.lang.annotation.ElementType;
23 import java.lang.annotation.Retention;
24 import java.lang.annotation.RetentionPolicy;
25 import java.lang.annotation.Target;
26
27 import javax.inject.Qualifier;
28 import javax.validation.ConstraintViolationException;
29
30 /**
31 * Marker for methods which arguments have to be validated.
32 */
33 @Qualifier
34 @Retention( RetentionPolicy.RUNTIME )
35 @Target( { ElementType.METHOD } )
36 public @interface Validate
37 {
38
39 /**
40 * The groups have to be validated, empty by default.
41 *
42 * @return the groups have to be validated, empty by default.
43 */
44 Class<?>[] groups() default {};
45
46 /**
47 * Marks if the returned object by the intercepted method execution has to be validated, false by default.
48 *
49 * @return false by default.
50 */
51 boolean validateReturnedValue() default false;
52
53 /**
54 * The exception re-thrown when an error occurs during the validation.
55 *
56 * @return the exception re-thrown when an error occurs during the validation.
57 */
58 Class<? extends Throwable> rethrowExceptionsAs() default ConstraintViolationException.class;
59
60 /**
61 * A custom error message when throwing the custom exception. It supports java.util.Formatter place holders,
62 * intercepted method arguments will be used as message format arguments.
63 *
64 * @return a custom error message when throwing the custom exception.
65 * @see java.util.Formatter#format(String, Object...)
66 */
67 String exceptionMessage() default "";
68
69 }