/*******************************************************************************
* Copyright (c) 2004, 2008 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.che.ide.ext.java.jdt.core.dom;
import java.util.ArrayList;
import java.util.List;
/**
* End-of-line comment AST node type.
* <p>
* End-of-line comments begin with "//", must end with a line delimiter (as per JLS 3.7), and must not contain line breaks.
* </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>
*
* @noinstantiate This class is not intended to be instantiated by clients.
* @since 3.0
*/
public final class LineComment extends Comment {
/** A list of property descriptors (element type: {@link StructuralPropertyDescriptor}), or null if uninitialized. */
private static final List PROPERTY_DESCRIPTORS;
static {
List propertyList = new ArrayList(1);
createPropertyList(LineComment.class, propertyList);
PROPERTY_DESCRIPTORS = reapPropertyList(propertyList);
}
/**
* 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 line 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
*/
LineComment(AST ast) {
super(ast);
}
/* (omit javadoc for this method) Method declared on ASTNode. */
final List internalStructuralPropertiesForType(int apiLevel) {
return propertyDescriptors(apiLevel);
}
/* (omit javadoc for this method) Method declared on ASTNode. */
final int getNodeType0() {
return LINE_COMMENT;
}
/* (omit javadoc for this method) Method declared on ASTNode. */
ASTNode clone0(AST target) {
LineComment result = new LineComment(target);
result.setSourceRange(getStartPosition(), getLength());
return result;
}
/* (omit javadoc for this method) Method declared on ASTNode. */
final boolean subtreeMatch0(ASTMatcher matcher, Object other) {
// dispatch to correct overloaded match method
return matcher.match(this, other);
}
/* (omit javadoc for this method) Method declared on ASTNode. */
void accept0(ASTVisitor visitor) {
visitor.visit(this);
visitor.endVisit(this);
}
/* (omit javadoc for this method) Method declared on ASTNode. */
int memSize() {
return super.memSize();
}
/* (omit javadoc for this method) Method declared on ASTNode. */
int treeSize() {
return memSize();
}
}