Package org.codenarc.rule.comments

Class CommentsUtil

java.lang.Object

org.codenarc.rule.comments.CommentsUtil

All Implemented Interfaces:

groovy.lang.GroovyObject

public class CommentsUtil
extends java.lang.Object
implements groovy.lang.GroovyObject

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	JAVADOC_ANY_LINES
protected static java.lang.String	JAVADOC_EMPTY_LINE
protected static java.lang.String	JAVADOC_END
protected static java.lang.String	JAVADOC_LINE_PREFIX
protected static java.lang.String	JAVADOC_LINE_WITH_TEXT
protected static java.lang.String	JAVADOC_START
protected static java.lang.String	NEW_LINE
protected static java.lang.String	NON_WHITESPACE_CHARS
protected static java.lang.String	OPTIONAL_WHITESPACE
protected static java.lang.String	RELUCTANT
protected static java.lang.String	WHITESPACE

Constructor Summary

Constructors

Constructor	Description
CommentsUtil()

Method Summary

Modifier and Type	Method	Description
groovy.lang.MetaClass	getMetaClass()
java.lang.Object	getProperty(java.lang.String property)
protected static java.lang.String	group(java.lang.String inside)
protected static boolean	hasTextOnNextLine(SourceCode sourceCode, int lineNumber)
java.lang.Object	invokeMethod(java.lang.String method, java.lang.Object arguments)
void	setMetaClass(groovy.lang.MetaClass mc)
void	setProperty(java.lang.String property, java.lang.Object value)

Methods inherited from class java.lang.Object

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

Field Detail

WHITESPACE

protected static final java.lang.String WHITESPACE

See Also:

Constant Field Values

OPTIONAL_WHITESPACE

protected static final java.lang.String OPTIONAL_WHITESPACE

See Also:

Constant Field Values

NON_WHITESPACE_CHARS

protected static final java.lang.String NON_WHITESPACE_CHARS

See Also:

Constant Field Values

NEW_LINE

protected static final java.lang.String NEW_LINE

See Also:

Constant Field Values

RELUCTANT

protected static final java.lang.String RELUCTANT

JAVADOC_START

protected static final java.lang.String JAVADOC_START

See Also:

Constant Field Values

JAVADOC_ANY_LINES

protected static final java.lang.String JAVADOC_ANY_LINES

JAVADOC_EMPTY_LINE

protected static final java.lang.String JAVADOC_EMPTY_LINE

See Also:

Constant Field Values

JAVADOC_END

protected static final java.lang.String JAVADOC_END

See Also:

Constant Field Values

JAVADOC_LINE_PREFIX

protected static final java.lang.String JAVADOC_LINE_PREFIX

See Also:

Constant Field Values

JAVADOC_LINE_WITH_TEXT

protected static final java.lang.String JAVADOC_LINE_WITH_TEXT

Constructor Detail

CommentsUtil

public CommentsUtil()

Method Detail

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

setMetaClass

public void setMetaClass(groovy.lang.MetaClass mc)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject

invokeMethod

public java.lang.Object invokeMethod(java.lang.String method,
                                     java.lang.Object arguments)

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

getProperty

public java.lang.Object getProperty(java.lang.String property)

Specified by:

getProperty in interface groovy.lang.GroovyObject

setProperty

public void setProperty(java.lang.String property,
                        java.lang.Object value)

Specified by:

setProperty in interface groovy.lang.GroovyObject

group

protected static java.lang.String group(java.lang.String inside)

hasTextOnNextLine

protected static boolean hasTextOnNextLine(SourceCode sourceCode,
                                           int lineNumber)