1 /*
2 * Metis: Java Data Framework
3 * Copyright 2012-2026. Tony Washer
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy
7 * 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, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17 package io.github.tonywasher.joceanus.metis.field;
18
19 /**
20 * Field presence status.
21 */
22 public enum MetisFieldRequired {
23 /**
24 * Must exist.
25 */
26 MUSTEXIST,
27
28 /**
29 * Can exist.
30 */
31 CANEXIST,
32
33 /**
34 * Not Allowed.
35 */
36 NOTALLOWED;
37
38 /**
39 * must the field exist?
40 *
41 * @return true/false
42 */
43 public boolean mustExist() {
44 return this == MUSTEXIST;
45 }
46
47 /**
48 * is the field notAllowed?
49 *
50 * @return true/false
51 */
52 public boolean notAllowed() {
53 return this == NOTALLOWED;
54 }
55 }