platform/lang-api/src/com/intellij/psi/PsiComment.java

   1 /*
   2  * Copyright 2000-2007 JetBrains s.r.o.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package com.intellij.psi;
  17
  18 import com.intellij.psi.tree.IElementType;
  19
  20 /**
  21  * Represents a comment in Java code or in a custom language.
  22  */
  23 public interface PsiComment extends PsiElement {
  24   /**
  25    * Returns the token type of the comment (for example, {@link JavaTokenType#END_OF_LINE_COMMENT} or
  26    * {@link JavaTokenType#C_STYLE_COMMENT}).
  27    *
  28    * @return the token type of the comment.
  29    */
  30   IElementType getTokenType();
  31 }