Package com.intellij.codeInsight.folding.impl

Class CommentFoldingUtil

java.lang.Object

com.intellij.codeInsight.folding.impl.CommentFoldingUtil

public final class CommentFoldingUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CommentFoldingUtil()

Method Summary

Modifier and Type	Method and Description
static FoldingDescriptor	getCommentDescriptor(PsiComment comment, Document document, java.util.Set<? super PsiElement> processedComments, java.util.function.Predicate<? super PsiElement> isCustomRegionFunc, boolean isCollapse) Construct descriptor for comment folding.
static java.lang.String	getCommentHeader(Document document, java.lang.String commentSuffix, java.lang.String commentPrefix, java.lang.String linePrefix, TextRange commentRange) Get first non-blank line from comment.
static java.lang.String	getCommentPlaceholder(Document document, IElementType commentType, TextRange commentRange) Construct placeholder for comment based on its type.
static java.lang.String	getCommentPlaceholder(Document document, IElementType commentType, TextRange commentRange, java.lang.String replacement) Construct placeholder for comment based on its type.
static java.lang.String	getCommentPlaceholder(java.lang.String prefix, java.lang.String suffix, java.lang.String text, java.lang.String replacement) Construct comment placeholder based on rule placeholder ::= prefix[text ]replacement[suffix] .
static java.lang.String	getCommentText(Document document, java.lang.String commentSuffix, java.lang.String commentPrefix, java.lang.String linePrefix, TextRange commentRange) Get comment text excluding prefixes and suffixes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommentFoldingUtil

public CommentFoldingUtil()

Method Detail

getCommentDescriptor

public static FoldingDescriptor getCommentDescriptor(PsiComment comment,
                                                     Document document,
                                                     java.util.Set<? super PsiElement> processedComments,
                                                     java.util.function.Predicate<? super PsiElement> isCustomRegionFunc,
                                                     boolean isCollapse)

Construct descriptor for comment folding.

Parameters:

comment - comment to fold

document - document with comment

isCollapse - is comment collapsed by default or not

processedComments - already processed comments

isCustomRegionFunc - determines whether element contains custom region tag

getCommentPlaceholder

public static java.lang.String getCommentPlaceholder(Document document,
                                                     IElementType commentType,
                                                     TextRange commentRange)

Construct placeholder for comment based on its type.

Parameters:

document - document with comment

commentType - type of comment

commentRange - text range of comment

getCommentPlaceholder

public static java.lang.String getCommentPlaceholder(Document document,
                                                     IElementType commentType,
                                                     TextRange commentRange,
                                                     java.lang.String replacement)

Construct placeholder for comment based on its type.

Parameters:

document - document with comment

commentType - type of comment

commentRange - text range of comment

replacement - replacement for comment content. included in placeholder

getCommentPlaceholder

public static java.lang.String getCommentPlaceholder(java.lang.String prefix,
                                                     java.lang.String suffix,
                                                     java.lang.String text,
                                                     java.lang.String replacement)

Construct comment placeholder based on rule placeholder ::= prefix[text ]replacement[suffix] .

Parameters:

text - part of comment content to include in placeholder

replacement - replacement for the rest of comment content

getCommentHeader

public static java.lang.String getCommentHeader(Document document,
                                                java.lang.String commentSuffix,
                                                java.lang.String commentPrefix,
                                                java.lang.String linePrefix,
                                                TextRange commentRange)

Get first non-blank line from comment. If line with comment prefix contains text then it will be used as header, otherwise second line will be used. If both lines are blank or comment contains only one line then empty string is returned.

Parameters:

document - document with comment

commentSuffix - doc comment suffix

linePrefix - prefix for doc comment line

commentRange - comment text range in document

getCommentText

public static java.lang.String getCommentText(Document document,
                                              java.lang.String commentSuffix,
                                              java.lang.String commentPrefix,
                                              java.lang.String linePrefix,
                                              TextRange commentRange)

Get comment text excluding prefixes and suffixes. If line contains whitespaces they will be included as well.

Parameters:

document - document with comment

commentSuffix - doc comment suffix

commentPrefix - doc comment prefix

linePrefix - prefix for doc comment line

commentRange - comment text range in document