1 /*
   2  * Copyright (c) 2005, 2014, 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.source.tree;
  27 
  28 import javax.lang.model.element.Name;
  29 
  30 /**
  31  * A tree node for a {@code break} statement.
  32  *
  33  * For example:
  34  * <pre>
  35  *   break;
  36  *
  37  *   break <em>label</em> ;
  38  *
  39  *   break <em>expression</em> ;
  40  * </pre>
  41  *
  42  * @jls section 14.15
  43  *
  44  * @author Peter von der Ah&eacute;
  45  * @author Jonathan Gibbons
  46  * @since 1.6
  47  */
  48 public interface BreakTree extends StatementTree {
  49     /**
  50      * Returns the label for this {@code break} statement.
  51      * @return the label
  52      */
  53     Name getLabel();
  54 
  55     /**
  56      * Returns the expression for this {@code break} statement.
  57      * 
  58      * @apiNote
  59      * This method is modeling value breaks, which are part of
  60      * a preview feature and may be removed if the preview feature
  61      * is removed.
  62      * 
  63      * @return the expression
  64      * @since 12
  65      */
  66     @Deprecated(forRemoval=true, since="12")
  67     ExpressionTree getValue();
  68 }