1 /*
   2  * Copyright (c) 2019, 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 javax.lang.model.element;
  27 
  28 /**
  29  * {@preview Associated with records, a preview feature of the Java language.
  30  *
  31  *           This class is associated with <i>records</i>, a preview
  32  *           feature of the Java language. Programs can only use this
  33  *           method when preview features are enabled. Preview features
  34  *           may be removed in a future release, or upgraded to permanent
  35  *           features of the Java language.}
  36  *
  37  * Represents a record component.
  38  *
  39  * @since 14
  40  */
  41 @jdk.internal.PreviewFeature(feature=jdk.internal.PreviewFeature.Feature.RECORDS,
  42                              essentialAPI=false)
  43 @SuppressWarnings("preview")
  44 public interface RecordComponentElement extends Element {
  45     /**
  46      * Returns the enclosing element of this record component.
  47      *
  48      * The enclosing element of a record component is the type
  49      * declaring the record component.
  50      *
  51      * @return the enclosing element of this record component
  52      */
  53     @Override
  54     Element getEnclosingElement();
  55 
  56     /**
  57      * Returns the simple name of this record component.
  58      *
  59      * <p>The name of each record component must be distinct from the
  60      * names of all other record components.
  61      *
  62      * @return the simple name of this record component
  63      *
  64      * @jls 6.2 Names and Identifiers
  65      */
  66     @Override
  67     Name getSimpleName();
  68 
  69     /**
  70      * Returns the executable element for the accessor associated with the
  71      * given record component.
  72      *
  73      * @return the record component accessor.
  74      */
  75     ExecutableElement getAccessor();
  76 }