Copyright (c) 2004, 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
/*******************************************************************************
* Copyright (c) 2004, 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 comment AST node type.
Block comments (also called "traditional" comments in JLS 3.7) begin with "/*", may contain line breaks, and must end with "*/". Following the definition in the JLS (first edition but not second edition), block comment normally exclude comments that begin with "/*#42;", which are instead classified as doc comments (Javadoc
).
Note that this node type is a comment placeholder, and is
only useful for recording the source range where a comment
was found in a source string. It is not useful for creating
comments.
Since: 3.0 @noinstantiate This class is not intended to be instantiated by clients.
/**
* Block comment AST node type.
* <p>
* Block comments (also called "traditional" comments in JLS 3.7)
* begin with "/*", may contain line breaks, and must end
* with "*/". Following the definition in the JLS (first edition
* but not second edition), block comment normally exclude comments
* that begin with "/*#42;", which are instead classified as doc
* comments ({@link Javadoc}).
* </p>
* <p>
* Note that this node type is a comment placeholder, and is
* only useful for recording the source range where a comment
* was found in a source string. It is not useful for creating
* comments.
* </p>
*
* @since 3.0
* @noinstantiate This class is not intended to be instantiated by clients.
*/
@SuppressWarnings("rawtypes")
public final class BlockComment extends Comment {
A list of property descriptors (element type: StructuralPropertyDescriptor
), or null if uninitialized. /**
* A list of property descriptors (element type:
* {@link StructuralPropertyDescriptor}),
* or null if uninitialized.
*/
private static final List PROPERTY_DESCRIPTORS;
static {
List properyList = new ArrayList(1);
createPropertyList(BlockComment.class, properyList);
PROPERTY_DESCRIPTORS = reapPropertyList(properyList);
}
Returns a list of structural property descriptors for this node type.
Clients must not modify the result.
Params: - apiLevel – the API level; one of the
AST.JLS*
constants
Returns: a list of property descriptors (element type: StructuralPropertyDescriptor
) Since: 3.0
/**
* 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;
}
Creates a new block comment node owned by the given AST.
N.B. This constructor is package-private.
Params: - ast – the AST that is to own this node
/**
* Creates a new block comment node owned by the given AST.
* <p>
* N.B. This constructor is package-private.
* </p>
*
* @param ast the AST that is to own this node
*/
BlockComment(AST ast) {
super(ast);
}
@Override
final List internalStructuralPropertiesForType(int apiLevel) {
return propertyDescriptors(apiLevel);
}
@Override
final int getNodeType0() {
return BLOCK_COMMENT;
}
@Override
ASTNode clone0(AST target) {
BlockComment result = new BlockComment(target);
result.setSourceRange(getStartPosition(), getLength());
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) {
visitor.visit(this);
visitor.endVisit(this);
}
@Override
int memSize() {
return super.memSize();
}
@Override
int treeSize() {
return memSize();
}
}