org.eclipse.jdt.core.dom.Block.java Source code

Introduction

Here is the source code for org.eclipse.jdt.core.dom.Block.java

Source

/*******************************************************************************
 * Copyright (c) 2000, 2013 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.jdt.core.dom;

import java.util.ArrayList;
import java.util.List;

/**
 * Block statement AST node type.
 *
 * <pre>
 * Block:
 *    <b>{</b> { Statement } <b>}</b>
 * </pre>
 *
 * @since 2.0
 * @noinstantiate This class is not intended to be instantiated by clients.
 */
@SuppressWarnings({ "rawtypes", "unchecked" })
public class Block extends Statement {

    /**
     * The "statements" structural property of this node type (element type: {@link Statement}).
     * @since 3.0
     */
    public static final ChildListPropertyDescriptor STATEMENTS_PROPERTY = new ChildListPropertyDescriptor(
            Block.class, "statements", Statement.class, CYCLE_RISK); //$NON-NLS-1$

    /**
     * A list of property descriptors (element type:
     * {@link StructuralPropertyDescriptor}),
     * or null if uninitialized.
     */
    private static final List PROPERTY_DESCRIPTORS;

    static {
        List properyList = new ArrayList(2);
        createPropertyList(Block.class, properyList);
        addProperty(STATEMENTS_PROPERTY, properyList);
        PROPERTY_DESCRIPTORS = reapPropertyList(properyList);
    }

    /**
     * Returns a list of structural property descriptors for this node type.
     * Clients must not modify the result.
     *
     * @param apiLevel the API level; one of the
     * <code>AST.JLS*</code> constants
     * @return a list of property descriptors (element type:
     * {@link StructuralPropertyDescriptor})
     * @since 3.0
     */
    public static List propertyDescriptors(int apiLevel) {
        return PROPERTY_DESCRIPTORS;
    }

    /**
     * The list of statements (element type: {@link Statement}).
     * Defaults to an empty list.
     */
    private ASTNode.NodeList statements = new ASTNode.NodeList(STATEMENTS_PROPERTY);

    /**
     * Creates a new unparented block node owned by the given AST.
     * By default, the block is empty.
     * <p>
     * N.B. This constructor is package-private.
     * </p>
     *
     * @param ast the AST that is to own this node
     */
    Block(AST ast) {
        super(ast);
    }

    @Override
    final List internalStructuralPropertiesForType(int apiLevel) {
        return propertyDescriptors(apiLevel);
    }

    @Override
    final List internalGetChildListProperty(ChildListPropertyDescriptor property) {
        if (property == STATEMENTS_PROPERTY) {
            return statements();
        }
        // allow default implementation to flag the error
        return super.internalGetChildListProperty(property);
    }

    @Override
    final int getNodeType0() {
        return BLOCK;
    }

    @Override
    ASTNode clone0(AST target) {
        Block result = new Block(target);
        result.setSourceRange(getStartPosition(), getLength());
        result.copyLeadingComment(this);
        result.statements().addAll(ASTNode.copySubtrees(target, statements()));
        return result;
    }

    @Override
    final boolean subtreeMatch0(ASTMatcher matcher, Object other) {
        // dispatch to correct overloaded match method
        return matcher.match(this, other);
    }

    @Override
    void accept0(ASTVisitor visitor) {
        boolean visitChildren = visitor.visit(this);
        if (visitChildren) {
            acceptChildren(visitor, this.statements);
        }
        visitor.endVisit(this);
    }

    /**
     * Returns the live list of statements in this block. Adding and
     * removing nodes from this list affects this node dynamically.
     * All nodes in this list must be <code>Statement</code>s;
     * attempts to add any other type of node will trigger an
     * exception.
     *
     * @return the live list of statements in this block
     *    (element type: {@link Statement})
     */
    public List statements() {
        return this.statements;
    }

    @Override
    int memSize() {
        return super.memSize() + 1 * 4;
    }

    @Override
    int treeSize() {
        return memSize() + this.statements.listSize();
    }
}