Eclipse JDT Plug-in Developer Guide (Galileo) - SwitchCase (Eclipse JDT API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse JDT
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jdt.core.dom
Class SwitchCase


java.lang.Object
  

org.eclipse.jdt.core.dom.ASTNode
      

org.eclipse.jdt.core.dom.Statement
          
org.eclipse.jdt.core.dom.SwitchCase

public class SwitchCase
extends Statement
extends Statement

Switch case AST node type. A switch case is a special kind of node used only in switch statements. It is a Statement in name only.

 SwitchCase:
                case Expression  :
                default :

Since:: 2.0
Restriction:: This class is not intended to be instantiated by clients.

Field Summary

static ChildPropertyDescriptor EXPRESSION_PROPERTY
          The "expression" structural property of this node type.

Fields inherited from class org.eclipse.jdt.core.dom. ASTNode

ANNOTATION_TYPE_DECLARATION, ANNOTATION_TYPE_MEMBER_DECLARATION, ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BLOCK_COMMENT, BOOLEAN_LITERAL, BREAK_STATEMENT, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, DO_STATEMENT, EMPTY_STATEMENT, ENHANCED_FOR_STATEMENT, ENUM_CONSTANT_DECLARATION, ENUM_DECLARATION, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, JAVADOC, LABELED_STATEMENT, LINE_COMMENT, MALFORMED, MARKER_ANNOTATION, MEMBER_REF, MEMBER_VALUE_PAIR, METHOD_DECLARATION, METHOD_INVOCATION, METHOD_REF, METHOD_REF_PARAMETER, MODIFIER, NORMAL_ANNOTATION, NULL_LITERAL, NUMBER_LITERAL, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, QUALIFIED_NAME, QUALIFIED_TYPE, RECOVERED, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_MEMBER_ANNOTATION, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SWITCH_CASE, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, TAG_ELEMENT, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_PARAMETER, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE

Method Summary

Expression getExpression ()
          Returns the expression of this switch case, or null if there is none (the "default:" case).

boolean isDefault ()
          Returns whether this switch case represents the "default:" case.

static List propertyDescriptors (int apiLevel)
          Returns a list of structural property descriptors for this node type.

void setExpression ( Expression expression)
          Sets the expression of this switch case, or clears it (turns it into the "default:" case).

Methods inherited from class org.eclipse.jdt.core.dom. Statement

getLeadingComment, setLeadingComment

Methods inherited from class org.eclipse.jdt.core.dom. ASTNode

accept, copySubtree, copySubtrees, delete, equals, getAST, getFlags, getLength, getLocationInParent, getNodeType, getParent, getProperty, getRoot, getStartPosition, getStructuralProperty, hashCode, nodeClassForType, properties, setFlags, setProperty, setSourceRange, setStructuralProperty, structuralPropertiesForType, subtreeBytes, subtreeMatch, toString

Methods inherited from class java.lang. Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EXPRESSION_PROPERTY

public static final 
ChildPropertyDescriptor EXPRESSION_PROPERTY

The "expression" structural property of this node type.

Since:: 3.0

Method Detail

propertyDescriptors

public static 
List propertyDescriptors(int apiLevel)

Returns a list of structural property descriptors for this node type. Clients must not modify the result.

Parameters:: apiLevel - the API level; one of the AST.JLS* constants
Returns:: a list of property descriptors (element type: StructuralPropertyDescriptor)
Since:: 3.0

getExpression

public 
Expression getExpression()

Returns the expression of this switch case, or null if there is none (the "default:" case).

Returns:: the expression node, or null if there is none

setExpression

public void setExpression(
Expression expression)

Sets the expression of this switch case, or clears it (turns it into the "default:" case).

Parameters:

expression - the expression node, or null to turn it into the "default:" case

Throws:


IllegalArgumentException

- if:

the node belongs to a different AST
the node already has a parent
a cycle in would be created

isDefault

public boolean isDefault()

Returns whether this switch case represents the "default:" case.

This convenience method is equivalent to getExpression() == null.

Returns:: true if this is the default switch case, and false if this is a non-default switch case