Package: ParticipationConstraints

ParticipationConstraints

Coverage

1: /**
2: * Copyright (C) 2022 Czech Technical University in Prague
3: *
4: * This program is free software: you can redistribute it and/or modify it under
5: * the terms of the GNU General Public License as published by the Free Software
6: * Foundation, either version 3 of the License, or (at your option) any
7: * later version.
8: *
9: * This program is distributed in the hope that it will be useful, but WITHOUT
10: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
12: * details. You should have received a copy of the GNU General Public License
13: * along with this program. If not, see <http://www.gnu.org/licenses/>.
14: */
15: package cz.cvut.kbss.jopa.model.annotations;
16:
17: import java.lang.annotation.Documented;
18: import java.lang.annotation.ElementType;
19: import java.lang.annotation.Retention;
20: import java.lang.annotation.RetentionPolicy;
21: import java.lang.annotation.Target;
22:
23: /**
24: * Allows to specify participation constraints of an attribute.
25: */
26: @Documented
27: @Retention(RetentionPolicy.RUNTIME)
28: @Target(ElementType.FIELD)
29: public @interface ParticipationConstraints {
30:
31: ParticipationConstraint[] value() default {};
32:
33: /**
34: * (Optional) Whether the annotated field can be empty, i.e. {@code null} for singular attributes and {@code null}
35: * or empty for plural attributes (this is up to the implementation).
36: * <p>
37: * This attributes corresponds to using a {@link ParticipationConstraint} with {@code min = 1}.
38: * <p>
39: * In case there are participation constraints specified as values of this annotation, the {@code nonEmpty} value is
40: * ignored.
41: *
42: * @return Whether the field can be empty
43: */
44: boolean nonEmpty() default false;
45: }