Top Description Fields Constructors Methods
com.github.javaparser.ast.stmt

public Class BreakStmt

extends Statement
Class Inheritance
Imports
com.github.javaparser.ast.AllFieldsConstructor, .Node, .Generated, com.github.javaparser.ast.expr.SimpleName, com.github.javaparser.ast.observer.ObservableProperty, com.github.javaparser.ast.visitor.GenericVisitor, .VoidVisitor, .CloneVisitor, java.util.Optional, com.github.javaparser.metamodel.BreakStmtMetaModel, .JavaParserMetaModel, .OptionalProperty, com.github.javaparser.TokenRange, java.util.function.Consumer

The break statement

Java 1.0-11

Break has an optional label:
break;
break somewhere;
The label is in the "value" property as a NameExpr.

Java 12

Break can now also have any expression, to be used in the switch-expression:
break 123+456;
break "more or less";
The expression will be in the "value" property.

Java 13

The break statement has been reverted to what it was before Java 12, and break-with-value is now the YieldStatement.
Author
Julio Vilmar Gesser
See Also
com.github.javaparser.ast.expr.SwitchExpr, YieldStmt

Field Summary

Modifier and TypeField and Description
private SimpleName
label

Constructor Summary

AccessConstructor and Description
public
BreakStmt()

public
BreakStmt(final String label)

public
BreakStmt(final SimpleName label)

public
BreakStmt(TokenRange tokenRange, SimpleName label)

This constructor is used by the parser and is considered private.

Method Summary

Modifier and TypeMethod and Description
public <R, A> R
accept(final GenericVisitor<R, A>
the visitor implementation
v, final A
the argument passed to the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public <A> void
accept(final VoidVisitor<A>
the visitor implementation
v, final A
any value relevant for the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public BreakStmt
asBreakStmt()

Overrides com.github.javaparser.ast.stmt.Statement.asBreakStmt.

public BreakStmt
clone()

Overrides com.github.javaparser.ast.stmt.Statement.clone.

Creates and returns a copy of this object.
public Optional<SimpleName>
getLabel()

public BreakStmtMetaModel
getMetaModel()

Overrides com.github.javaparser.ast.stmt.Statement.getMetaModel.

public void
ifBreakStmt(Consumer<BreakStmt> action)

Overrides com.github.javaparser.ast.stmt.Statement.ifBreakStmt.

public boolean
isBreakStmt()

Overrides com.github.javaparser.ast.stmt.Statement.isBreakStmt.

public boolean
remove(Node node)

Overrides com.github.javaparser.ast.stmt.Statement.remove.

public BreakStmt
removeLabel()

public boolean
replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.stmt.Statement.replace.

public BreakStmt

Returns:

this, the BreakStmt
setLabel(final SimpleName
the label, can be null
label)

Sets the label

public Optional<BreakStmt>
toBreakStmt()

Overrides com.github.javaparser.ast.stmt.Statement.toBreakStmt.

Inherited from com.github.javaparser.ast.stmt.Statement:
asAssertStmtasBlockStmtasContinueStmtasDoStmtasEmptyStmtasExplicitConstructorInvocationStmtasExpressionStmtasForEachStmtasForStmtasIfStmtasLabeledStmtasLocalClassDeclarationStmtasReturnStmtasSwitchStmtasSynchronizedStmtasThrowStmtasTryStmtasUnparsableStmtasWhileStmtasYieldStmtifAssertStmtifBlockStmtifContinueStmtifDoStmtifEmptyStmtifExplicitConstructorInvocationStmtifExpressionStmtifForEachStmtifForStmtifIfStmtifLabeledStmtifLocalClassDeclarationStmtifReturnStmtifSwitchStmtifSynchronizedStmtifThrowStmtifTryStmtifUnparsableStmtifWhileStmtifYieldStmtisAssertStmtisBlockStmtisContinueStmtisDoStmtisEmptyStmtisExplicitConstructorInvocationStmtisExpressionStmtisForEachStmtisForStmtisIfStmtisLabeledStmtisLocalClassDeclarationStmtisReturnStmtisSwitchStmtisSynchronizedStmtisThrowStmtisTryStmtisUnparsableStmtisWhileStmtisYieldStmttoAssertStmttoBlockStmttoContinueStmttoDoStmttoEmptyStmttoExplicitConstructorInvocationStmttoExpressionStmttoForEachStmttoForStmttoIfStmttoLabeledStmttoLocalClassDeclarationStmttoReturnStmttoSwitchStmttoSynchronizedStmttoThrowStmttoTryStmttoUnparsableStmttoWhileStmttoYieldStmt

Field Detail

labelback to summary
private SimpleName label
Annotations
@OptionalProperty

Constructor Detail

BreakStmtback to summary
public BreakStmt()
BreakStmtback to summary
public BreakStmt(final String label)
BreakStmtback to summary
public BreakStmt(final SimpleName label)
Annotations
@AllFieldsConstructor
BreakStmtback to summary
public BreakStmt(TokenRange tokenRange, SimpleName label)

This constructor is used by the parser and is considered private.

Annotations
@Generated:com.github.javaparser.generator.core.node.MainConstructorGenerator

Method Detail

acceptback to summary
public <R, A> R accept(final GenericVisitor<R, A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<R>
the type of the return value of the visitor
<A>
the type the user argument passed to the visitor
v:GenericVisitor<R, A>

the visitor implementation

arg:A

the argument passed to the visitor (of type A)

Returns:R

the result of the visit (of type R)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
acceptback to summary
public <A> void accept(final VoidVisitor<A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<A>
the type the argument passed for the visitor
v:VoidVisitor<A>

the visitor implementation

arg:A

any value relevant for the visitor (of type A)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
asBreakStmtback to summary
public BreakStmt asBreakStmt()

Overrides com.github.javaparser.ast.stmt.Statement.asBreakStmt.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
cloneback to summary
public BreakStmt clone()

Overrides com.github.javaparser.ast.stmt.Statement.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression: 

x.clone() != x
will be true, and that the expression: 
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that: 
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:BreakStmt

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
getLabelback to summary
public Optional<SimpleName> getLabel()
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getMetaModelback to summary
public BreakStmtMetaModel getMetaModel()

Overrides com.github.javaparser.ast.stmt.Statement.getMetaModel.

Returns:BreakStmtMetaModel

Doc from com.github.javaparser.ast.Node.getMetaModel.

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
ifBreakStmtback to summary
public void ifBreakStmt(Consumer<BreakStmt> action)

Overrides com.github.javaparser.ast.stmt.Statement.ifBreakStmt.

Annotations
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
isBreakStmtback to summary
public boolean isBreakStmt()

Overrides com.github.javaparser.ast.stmt.Statement.isBreakStmt.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
removeback to summary
public boolean remove(Node node)

Overrides com.github.javaparser.ast.stmt.Statement.remove.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.RemoveMethodGenerator
removeLabelback to summary
public BreakStmt removeLabel()
Annotations
@Generated:com.github.javaparser.generator.core.node.RemoveMethodGenerator
replaceback to summary
public boolean replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.stmt.Statement.replace.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.ReplaceMethodGenerator
setLabelback to summary
public BreakStmt setLabel(final SimpleName label)

Sets the label

Parameters
label:SimpleName

the label, can be null

Returns:BreakStmt

this, the BreakStmt

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
toBreakStmtback to summary
public Optional<BreakStmt> toBreakStmt()

Overrides com.github.javaparser.ast.stmt.Statement.toBreakStmt.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator