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

public Class CatchClause

extends Node
implements NodeWithBlockStmt<CatchClause>
Class Inheritance
All Implemented Interfaces
com.github.javaparser.ast.nodeTypes.NodeWithBlockStmt
Imports
com.github.javaparser.TokenRange, com.github.javaparser.ast.*, .Node, .Generated, com.github.javaparser.ast.body.Parameter, com.github.javaparser.ast.expr.AnnotationExpr, .SimpleName, com.github.javaparser.ast.nodeTypes.NodeWithBlockStmt, com.github.javaparser.ast.observer.ObservableProperty, com.github.javaparser.ast.type.ClassOrInterfaceType, com.github.javaparser.ast.visitor.CloneVisitor, .GenericVisitor, .VoidVisitor, com.github.javaparser.metamodel.CatchClauseMetaModel, .JavaParserMetaModel
The catch part of a try-catch-finally.
In try { ... } catch (Exception e) { ... } the CatchClause is catch (Exception e) { ... }. Exception e is the parameter. The { ... } is the body.
Author
Julio Vilmar Gesser

Field Summary

Modifier and TypeField and Description
private BlockStmt
body

private Parameter
parameter

Inherited from com.github.javaparser.ast.Node:
ABSOLUTE_BEGIN_LINEABSOLUTE_END_LINENODE_BY_BEGIN_POSITIONprettyPrinterNoCommentsConfigurationSYMBOL_RESOLVER_KEY

Constructor Summary

AccessConstructor and Description
public
CatchClause()

public
CatchClause(final NodeList<Modifier> exceptModifier, final NodeList<AnnotationExpr> exceptAnnotations, final ClassOrInterfaceType exceptType, final SimpleName exceptName, final BlockStmt body)

public
CatchClause(final Parameter parameter, final BlockStmt body)

public
CatchClause(TokenRange tokenRange, Parameter parameter, BlockStmt body)

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 CatchClause
clone()

Overrides com.github.javaparser.ast.Node.clone.

Creates and returns a copy of this object.
public BlockStmt
getBody()

Implements com.github.javaparser.ast.nodeTypes.NodeWithBlockStmt.getBody.

public CatchClauseMetaModel
getMetaModel()

Overrides com.github.javaparser.ast.Node.getMetaModel.

public Parameter
getParameter()

Note that the type of the Parameter can be a UnionType.

public boolean
remove(Node node)

Overrides com.github.javaparser.ast.Node.remove.

public boolean
replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.Node.replace.

public CatchClause
setBody(final BlockStmt body)

Implements com.github.javaparser.ast.nodeTypes.NodeWithBlockStmt.setBody.

public CatchClause
setParameter(final Parameter parameter)

Inherited from com.github.javaparser.ast.Node:
addOrphanCommentcontainsDatacustomInitializationequalsfindAllfindAllfindCompilationUnitfindFirstfindFirstfindFirstfindRootNodegetAllContainedCommentsgetChildNodesgetChildNodesByTypegetCommentgetDatagetDataKeysgetNodesByTypegetOrphanCommentsgetParentNodegetParentNodeForChildrengetParsedgetRangegetSymbolResolvergetTokenRangegetToStringPrettyPrinterConfigurationhashCodeisAncestorOfisRegisterednotifyPropertyChangeregisterregisterregisterForSubtreeremoveremoveCommentremoveDataremoveForcedremoveOrphanCommentreplacesetAsParentNodeOfsetAsParentNodeOfsetBlockCommentsetCommentsetDatasetLineCommentsetParentNodesetParsedsetRangesetTokenRangesetToStringPrettyPrinterConfigurationstreamstreamtoStringtoStringtryAddImportToParentCompilationUnitunregisterwalkwalkwalk

Field Detail

bodyback to summary
private BlockStmt body
parameterback to summary
private Parameter parameter

Constructor Detail

CatchClauseback to summary
public CatchClause()
CatchClauseback to summary
public CatchClause(final NodeList<Modifier> exceptModifier, final NodeList<AnnotationExpr> exceptAnnotations, final ClassOrInterfaceType exceptType, final SimpleName exceptName, final BlockStmt body)
CatchClauseback to summary
public CatchClause(final Parameter parameter, final BlockStmt body)
Annotations
@AllFieldsConstructor
CatchClauseback to summary
public CatchClause(TokenRange tokenRange, Parameter parameter, BlockStmt body)

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
cloneback to summary
public CatchClause clone()

Overrides com.github.javaparser.ast.Node.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:CatchClause

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
getBodyback to summary
public BlockStmt getBody()

Implements com.github.javaparser.ast.nodeTypes.NodeWithBlockStmt.getBody.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getMetaModelback to summary
public CatchClauseMetaModel getMetaModel()

Overrides com.github.javaparser.ast.Node.getMetaModel.

Returns:CatchClauseMetaModel

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

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
getParameterback to summary
public Parameter getParameter()

Note that the type of the Parameter can be a UnionType. In this case, any annotations found at the start of the catch(@X A a |...) are found directly in the Parameter. Annotations that are on the second or later type - catch(A a | @X B b ...) are found on those types.

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

Overrides com.github.javaparser.ast.Node.remove.

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

Overrides com.github.javaparser.ast.Node.replace.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.ReplaceMethodGenerator
setBodyback to summary
public CatchClause setBody(final BlockStmt body)

Implements com.github.javaparser.ast.nodeTypes.NodeWithBlockStmt.setBody.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setParameterback to summary
public CatchClause setParameter(final Parameter parameter)
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator