1/*
2 * Copyright (c) 1997, 2017, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.sun.xml.internal.bind.v2.model.core;
27
28import javax.xml.bind.annotation.XmlMimeType;
29import javax.xml.bind.annotation.XmlType;
30import javax.xml.bind.annotation.XmlInlineBinaryData;
31
32/**
33 * An Enum that indicates if the property is
34 * Element, ElementRef, Value, or Attribute.
35 *
36 * <p>
37 * Corresponds to the four different kind of {@link PropertyInfo}.
38 * @author Bhakti Mehta (bhakti.mehta@sun.com)
39 */
40public enum PropertyKind {
41    VALUE(true,false,Integer.MAX_VALUE),
42    ATTRIBUTE(false,false,Integer.MAX_VALUE),
43    ELEMENT(true,true,0),
44    REFERENCE(false,true,1),
45    MAP(false,true,2),
46    ;
47
48    /**
49     * This kind of property can have {@link XmlMimeType} and {@link XmlInlineBinaryData}
50     * annotation with it.
51     */
52    public final boolean canHaveXmlMimeType;
53
54    /**
55     * This kind of properties need to show up in {@link XmlType#propOrder()}.
56     */
57    public final boolean isOrdered;
58
59    /**
60     * {@code com.sun.xml.internal.bind.v2.runtime.property.PropertyFactory} benefits from having index numbers assigned to
61     * {@link #ELEMENT}, {@link #REFERENCE}, and {@link #MAP} in this order.
62     */
63    public final int propertyIndex;
64
65    PropertyKind(boolean canHaveExpectedContentType, boolean isOrdered, int propertyIndex) {
66        this.canHaveXmlMimeType = canHaveExpectedContentType;
67        this.isOrdered = isOrdered;
68        this.propertyIndex = propertyIndex;
69    }
70}
71