Package org.codenarc.rule.convention

Class TrailingCommaRule

java.lang.Object

org.codenarc.rule.AbstractRule

org.codenarc.rule.AbstractAstVisitorRule

org.codenarc.rule.convention.TrailingCommaRule

All Implemented Interfaces:

groovy.lang.GroovyObject, Rule

public class TrailingCommaRule
extends AbstractAstVisitorRule
implements groovy.lang.GroovyObject

Field Summary

Fields inherited from class org.codenarc.rule.AbstractAstVisitorRule

CLOSURE_TEXT, DEFAULT_CONST_NAME, DEFAULT_FIELD_NAME, DEFAULT_TEST_CLASS_NAMES, DEFAULT_TEST_FILES, DEFAULT_VAR_NAME

Constructor Summary

Constructors

Constructor	Description
TrailingCommaRule()

Method Summary

Modifier and Type	Method	Description
java.lang.Class	getAstVisitorClass()	Each concrete subclass must either set this property or define its own property with the same name
boolean	getCheckList()
boolean	getCheckMap()
boolean	getIgnoreSingleElementList()
boolean	getIgnoreSingleElementMap()
groovy.lang.MetaClass	getMetaClass()
java.lang.String	getName()
int	getPriority()
java.lang.Object	getProperty(java.lang.String property)
java.lang.Object	invokeMethod(java.lang.String method, java.lang.Object arguments)
boolean	isCheckList()
boolean	isCheckMap()
boolean	isIgnoreSingleElementList()
boolean	isIgnoreSingleElementMap()
void	setAstVisitorClass(java.lang.Class value)
void	setCheckList(boolean value)
void	setCheckMap(boolean value)
void	setIgnoreSingleElementList(boolean value)
void	setIgnoreSingleElementMap(boolean value)
void	setMetaClass(groovy.lang.MetaClass mc)
void	setName(java.lang.String value)	Set the unique name for this rule
void	setPriority(int value)	Set the priority for this rule
void	setProperty(java.lang.String property, java.lang.Object value)

Methods inherited from class org.codenarc.rule.AbstractAstVisitorRule

applyTo, getApplyToClassNames, getAstVisitor, getDoNotApplyToClassNames, setApplyToClassNames, setDoNotApplyToClassNames, shouldApplyThisRuleTo

Methods inherited from class org.codenarc.rule.AbstractRule

applyTo, createViolation, createViolation, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getCompilerPhase, getDescription, getDoNotApplyToFileNames, getDoNotApplyToFilesMatching, getViolationMessage, isEnabled, isReady, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setViolationMessage, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

TrailingCommaRule

public TrailingCommaRule()

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

getName

public java.lang.String getName()

Specified by:

getName in interface Rule

Specified by:

getName in class AbstractRule

Returns:

the unique name for this rule

setName

public void setName(java.lang.String value)

Description copied from class: AbstractRule

Set the unique name for this rule

Specified by:

setName in class AbstractRule

Parameters:

value - - the name for this rule; this should be unique

getPriority

public int getPriority()

Specified by:

getPriority in interface Rule

Specified by:

getPriority in class AbstractRule

Returns:

the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.

setPriority

public void setPriority(int value)

Description copied from class: AbstractRule

Set the priority for this rule

Specified by:

setPriority in class AbstractRule

Parameters:

value - - the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.

getAstVisitorClass

public java.lang.Class getAstVisitorClass()

Description copied from class: AbstractAstVisitorRule

Each concrete subclass must either set this property or define its own property with the same name

Overrides:

getAstVisitorClass in class AbstractAstVisitorRule

setAstVisitorClass

public void setAstVisitorClass(java.lang.Class value)

getCheckList

public boolean getCheckList()

isCheckList

public boolean isCheckList()

setCheckList

public void setCheckList(boolean value)

getCheckMap

public boolean getCheckMap()

isCheckMap

public boolean isCheckMap()

setCheckMap

public void setCheckMap(boolean value)

getIgnoreSingleElementList

public boolean getIgnoreSingleElementList()

isIgnoreSingleElementList

public boolean isIgnoreSingleElementList()

setIgnoreSingleElementList

public void setIgnoreSingleElementList(boolean value)

getIgnoreSingleElementMap

public boolean getIgnoreSingleElementMap()

isIgnoreSingleElementMap

public boolean isIgnoreSingleElementMap()

setIgnoreSingleElementMap

public void setIgnoreSingleElementMap(boolean value)