1 /*
   2  * Copyright (c) 1997, 2011, 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 
  26 package com.sun.xml.internal.bind.v2.model.core;
  27 
  28 import javax.xml.bind.annotation.XmlMimeType;
  29 import javax.xml.bind.annotation.XmlType;
  30 import javax.xml.bind.annotation.XmlInlineBinaryData;
  31 
  32 import com.sun.xml.internal.bind.v2.runtime.property.PropertyFactory;
  33 
  34 
  35 /**
  36  * An Enum that indicates if the property is
  37  * Element, ElementRef, Value, or Attribute.
  38  *
  39  * <p>
  40  * Corresponds to the four different kind of {@link PropertyInfo}.
  41  * @author Bhakti Mehta (bhakti.mehta@sun.com)
  42  */
  43 public enum PropertyKind {
  44     VALUE(true,false,Integer.MAX_VALUE),
  45     ATTRIBUTE(false,false,Integer.MAX_VALUE),
  46     ELEMENT(true,true,0),
  47     REFERENCE(false,true,1),
  48     MAP(false,true,2),
  49     ;
  50 
  51     /**
  52      * This kind of property can have {@link XmlMimeType} and {@link XmlInlineBinaryData}
  53      * annotation with it.
  54      */
  55     public final boolean canHaveXmlMimeType;
  56 
  57     /**
  58      * This kind of properties need to show up in {@link XmlType#propOrder()}.
  59      */
  60     public final boolean isOrdered;
  61 
  62     /**
  63      * {@link PropertyFactory} benefits from having index numbers assigned to
  64      * {@link #ELEMENT}, {@link #REFERENCE}, and {@link #MAP} in this order.
  65      */
  66     public final int propertyIndex;
  67 
  68     PropertyKind(boolean canHaveExpectedContentType, boolean isOrdered, int propertyIndex) {
  69         this.canHaveXmlMimeType = canHaveExpectedContentType;
  70         this.isOrdered = isOrdered;
  71         this.propertyIndex = propertyIndex;
  72     }
  73 }