1 /*
   2  * Copyright (c) 1997, 2012, 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.tools.internal.xjc.api;
  27 
  28 import javax.xml.namespace.QName;
  29 
  30 import com.sun.codemodel.internal.JType;
  31 
  32 /**
  33  * Represents a property of a wrapper-style element.
  34  *
  35  * <p>
  36  * Carrys information about one property of a wrapper-style
  37  * element. This interface is solely intended for the use by
  38  * the JAX-RPC and otherwise the use is discouraged.
  39  *
  40  * <p>
  41  * REVISIT: use CodeModel.
  42  *
  43  * @author
  44  *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
  45  * @see Mapping
  46  */
  47 public interface Property {
  48     /**
  49      * The name of the property.
  50      *
  51      * <p>
  52      * This method returns a valid identifier suitable for
  53      * the use as a variable name.
  54      *
  55      * @return
  56      *      always non-null. Camel-style name like "foo" or "barAndZot".
  57      *      Note that it may contain non-ASCII characters (CJK, etc.)
  58      *      The caller is responsible for proper escaping if it
  59      *      wants to print this as a variable name.
  60      */
  61     String name();
  62 
  63     /**
  64      * The Java type of the property.
  65      *
  66      * @return
  67      *      always non-null.
  68      *      {@link JType} is a representation of a Java type in a codeModel.
  69      *      If you just need the fully-qualified class name, call {@link JType#fullName()}.
  70      */
  71     JType type();
  72 
  73     /**
  74      * Name of the XML element that corresponds to the property.
  75      *
  76      * <p>
  77      * Each child of a wrapper style element corresponds with an
  78      * element, and this method returns that name.
  79      *
  80      * @return
  81      *      always non-null valid {@link QName}.
  82      */
  83     QName elementName();
  84 
  85     QName rawName();
  86 
  87 }