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

Java tutorial

Introduction

Here is the source code for org.eclipse.jdt.core.dom.Initializer.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;

/**
 * Static or instance initializer AST node type.
 * <pre>
 * Initializer:
 *     [ <b>static</b> ] Block
 * </pre>
 *
 * @since 2.0
 * @noinstantiate This class is not intended to be instantiated by clients.
 */
@SuppressWarnings({ "rawtypes" })
public class Initializer extends BodyDeclaration {

    /**
     * The "javadoc" structural property of this node type (child type: {@link Javadoc}).
     * @since 3.0
     */
    public static final ChildPropertyDescriptor JAVADOC_PROPERTY = internalJavadocPropertyFactory(
            Initializer.class);

    /**
     * The "modifiers" structural property of this node type (type: {@link Integer}) (JLS2 API only).
     * @since 3.0
     * @deprecated In the JLS3 API, this property is replaced by {@link #MODIFIERS2_PROPERTY}.
     */
    public static final SimplePropertyDescriptor MODIFIERS_PROPERTY = internalModifiersPropertyFactory(
            Initializer.class);

    /**
     * The "modifiers" structural property of this node type (element type: {@link IExtendedModifier}) (added in JLS3 API).
     * @since 3.1
     */
    public static final ChildListPropertyDescriptor MODIFIERS2_PROPERTY = internalModifiers2PropertyFactory(
            Initializer.class);

    /**
     * The "body" structural property of this node type (child type: {@link Block}).
     * @since 3.0
     */
    public static final ChildPropertyDescriptor BODY_PROPERTY = new ChildPropertyDescriptor(Initializer.class,
            "body", Block.class, MANDATORY, CYCLE_RISK); //$NON-NLS-1$

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

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

    static {
        List properyList = new ArrayList(4);
        createPropertyList(Initializer.class, properyList);
        addProperty(JAVADOC_PROPERTY, properyList);
        addProperty(MODIFIERS_PROPERTY, properyList);
        addProperty(BODY_PROPERTY, properyList);
        PROPERTY_DESCRIPTORS_2_0 = reapPropertyList(properyList);

        properyList = new ArrayList(4);
        createPropertyList(Initializer.class, properyList);
        addProperty(JAVADOC_PROPERTY, properyList);
        addProperty(MODIFIERS2_PROPERTY, properyList);
        addProperty(BODY_PROPERTY, properyList);
        PROPERTY_DESCRIPTORS_3_0 = 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) {
        if (apiLevel == AST.JLS2_INTERNAL) {
            return PROPERTY_DESCRIPTORS_2_0;
        } else {
            return PROPERTY_DESCRIPTORS_3_0;
        }
    }

    /**
     * The initializer body; lazily initialized; defaults to an empty block.
     */
    private Block body = null;

    /**
     * Creates a new AST node for an initializer declaration owned by the given
     * AST. By default, the initializer has no modifiers and an empty block.
     * The javadoc comment is not used for initializers.
     * <p>
     * N.B. This constructor is package-private.
     * </p>
     *
     * @param ast the AST that is to own this node
     */
    Initializer(AST ast) {
        super(ast);
    }

    /* (omit javadoc for this method)
     * Method declared on ASTNode.
     * @since 3.0
     */
    @Override
    final List internalStructuralPropertiesForType(int apiLevel) {
        return propertyDescriptors(apiLevel);
    }

    @Override
    final int internalGetSetIntProperty(SimplePropertyDescriptor property, boolean get, int value) {
        if (property == MODIFIERS_PROPERTY) {
            if (get) {
                return getModifiers();
            } else {
                internalSetModifiers(value);
                return 0;
            }
        }
        // allow default implementation to flag the error
        return super.internalGetSetIntProperty(property, get, value);
    }

    @Override
    final ASTNode internalGetSetChildProperty(ChildPropertyDescriptor property, boolean get, ASTNode child) {
        if (property == JAVADOC_PROPERTY) {
            if (get) {
                return getJavadoc();
            } else {
                setJavadoc((Javadoc) child);
                return null;
            }
        }
        if (property == BODY_PROPERTY) {
            if (get) {
                return getBody();
            } else {
                setBody((Block) child);
                return null;
            }
        }
        // allow default implementation to flag the error
        return super.internalGetSetChildProperty(property, get, child);
    }

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

    @Override
    final ChildPropertyDescriptor internalJavadocProperty() {
        return JAVADOC_PROPERTY;
    }

    @Override
    final ChildListPropertyDescriptor internalModifiers2Property() {
        return MODIFIERS2_PROPERTY;
    }

    @Override
    final SimplePropertyDescriptor internalModifiersProperty() {
        return MODIFIERS_PROPERTY;
    }

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

    @Override
    ASTNode clone0(AST target) {
        Initializer result = new Initializer(target);
        result.setSourceRange(getStartPosition(), getLength());
        if (this.ast.apiLevel == AST.JLS2_INTERNAL) {
            result.internalSetModifiers(getModifiers());
        }
        if (this.ast.apiLevel >= AST.JLS3_INTERNAL) {
            result.modifiers().addAll(ASTNode.copySubtrees(target, modifiers()));
        }
        result.setJavadoc((Javadoc) ASTNode.copySubtree(target, getJavadoc()));
        result.setBody((Block) getBody().clone(target));
        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) {
            acceptChild(visitor, getJavadoc());
            if (this.ast.apiLevel >= AST.JLS3_INTERNAL) {
                acceptChildren(visitor, this.modifiers);
            }
            acceptChild(visitor, getBody());
        }
        visitor.endVisit(this);
    }

    /**
     * Returns the body of this initializer declaration.
     *
     * @return the initializer body
     */
    public Block getBody() {
        if (this.body == null) {
            // lazy init must be thread-safe for readers
            synchronized (this) {
                if (this.body == null) {
                    preLazyInit();
                    this.body = new Block(this.ast);
                    postLazyInit(this.body, BODY_PROPERTY);
                }
            }
        }
        return this.body;
    }

    /**
     * Sets the body of this initializer declaration.
     *
     * @param body the block node
     * @exception IllegalArgumentException if:
     * <ul>
     * <li>the node belongs to a different AST</li>
     * <li>the node already has a parent</li>
     * <li>a cycle in would be created</li>
     * </ul>
     */
    public void setBody(Block body) {
        if (body == null) {
            throw new IllegalArgumentException();
        }
        ASTNode oldChild = this.body;
        preReplaceChild(oldChild, body, BODY_PROPERTY);
        this.body = body;
        postReplaceChild(oldChild, body, BODY_PROPERTY);
    }

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

    @Override
    int treeSize() {
        return memSize() + (this.optionalDocComment == null ? 0 : getJavadoc().treeSize())
                + (this.modifiers == null ? 0 : this.modifiers.listSize())
                + (this.body == null ? 0 : getBody().treeSize());
    }
}