Package: Enumerated

Enumerated

Coverage

1: /*
2: * JOPA
3: * Copyright (C) 2024 Czech Technical University in Prague
4: *
5: * This library is free software; you can redistribute it and/or
6: * modify it under the terms of the GNU Lesser General Public
7: * License as published by the Free Software Foundation; either
8: * version 3.0 of the License, or (at your option) any later version.
9: *
10: * This library is distributed in the hope that it will be useful,
11: * but WITHOUT ANY WARRANTY; without even the implied warranty of
12: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13: * Lesser General Public License for more details.
14: *
15: * You should have received a copy of the GNU Lesser General Public
16: * License along with this library.
17: */
18: package cz.cvut.kbss.jopa.model.annotations;
19:
20: import java.lang.annotation.*;
21:
22: /**
23: * Specifies that a persistent property or field should be persisted as an enumerated type.
24: * <p>
25: * If the enumerated type is not specified or the Enumerated annotation is not used, the EnumType value is assumed to be
26: * {@code STRING}.
27: */
28: @Documented
29: @Retention(RetentionPolicy.RUNTIME)
30: @Target({ElementType.FIELD,ElementType.METHOD})
31: public @interface Enumerated {
32:
33: /**
34: * (Optional) The type used in mapping an enum type.
35: *
36: * @return Enum mapping type
37: */
38: EnumType value() default EnumType.STRING;
39: }