Package com.intellij.psi.codeStyle.arrangement

Class ArrangementSectionDetector

java.lang.Object

com.intellij.psi.codeStyle.arrangement.ArrangementSectionDetector

public class ArrangementSectionDetector
extends java.lang.Object

Class that is able to detect arrangement section start/end from comment element.

The detection is based on arrangement settings.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArrangementSectionDetector.ArrangementSectionEntryTemplate

Constructor Summary

Constructors

Constructor and Description
ArrangementSectionDetector(Document document, ArrangementSettings settings, Consumer<? super ArrangementSectionDetector.ArrangementSectionEntryTemplate> producer)

Method Summary

Modifier and Type	Method and Description
static ArrangementSectionRule	isSectionStartComment(ArrangementSettings settings, java.lang.String comment)
boolean	processComment(PsiComment comment) Check if comment can be recognized as section start/end

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrangementSectionDetector

public ArrangementSectionDetector(Document document,
                                  ArrangementSettings settings,
                                  Consumer<? super ArrangementSectionDetector.ArrangementSectionEntryTemplate> producer)

Method Detail

processComment

public boolean processComment(PsiComment comment)

Check if comment can be recognized as section start/end

Returns:

true for section comment, false otherwise

isSectionStartComment

public static ArrangementSectionRule isSectionStartComment(ArrangementSettings settings,
                                                           java.lang.String comment)