org.codenarc.rule.formatting

Class BracesForTryCatchFinallyRule

java.lang.Object

org.codenarc.rule.AbstractRule

org.codenarc.rule.AbstractAstVisitorRule

org.codenarc.rule.formatting.BracesForTryCatchFinallyRule

All Implemented Interfaces:

groovy.lang.GroovyObject, Rule

public class BracesForTryCatchFinallyRule
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 and Description
BracesForTryCatchFinallyRule()

Method Summary

Modifier and Type	Method and Description
Class	getAstVisitorClass() Each concrete subclass must either set this property or define its own property with the same name
Boolean	getCatchOnSameLineAsClosingBrace()
Boolean	getCatchOnSameLineAsOpeningBrace()
Boolean	getFinallyOnSameLineAsClosingBrace()
Boolean	getFinallyOnSameLineAsOpeningBrace()
groovy.lang.MetaClass	getMetaClass()
String	getName()
int	getPriority()
Object	getProperty(String property)
boolean	getSameLine()
boolean	getValidateCatch()
boolean	getValidateFinally()
Object	invokeMethod(String method, Object arguments)
boolean	isSameLine()
boolean	isValidateCatch()
boolean	isValidateFinally()
void	setAstVisitorClass(Class value)
void	setCatchOnSameLineAsClosingBrace(Boolean value)
void	setCatchOnSameLineAsOpeningBrace(Boolean value)
void	setFinallyOnSameLineAsClosingBrace(Boolean value)
void	setFinallyOnSameLineAsOpeningBrace(Boolean value)
void	setMetaClass(groovy.lang.MetaClass mc)
void	setName(String value) Set the unique name for this rule
void	setPriority(int value) Set the priority for this rule
void	setProperty(String property, Object value)
void	setSameLine(boolean value)
void	setValidateCatch(boolean value)
void	setValidateFinally(boolean 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, createViolation, createViolation, createViolation, createViolationForImport, 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

BracesForTryCatchFinallyRule

public BracesForTryCatchFinallyRule()

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 Object invokeMethod(String method,
                           Object arguments)

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

getProperty

public Object getProperty(String property)

Specified by:

getProperty in interface groovy.lang.GroovyObject

setProperty

public void setProperty(String property,
                        Object value)

Specified by:

setProperty in interface groovy.lang.GroovyObject

getName

public 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(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 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(Class value)

getSameLine

public boolean getSameLine()

isSameLine

public boolean isSameLine()

setSameLine

public void setSameLine(boolean value)

getValidateCatch

public boolean getValidateCatch()

isValidateCatch

public boolean isValidateCatch()

setValidateCatch

public void setValidateCatch(boolean value)

getCatchOnSameLineAsClosingBrace

public Boolean getCatchOnSameLineAsClosingBrace()

setCatchOnSameLineAsClosingBrace

public void setCatchOnSameLineAsClosingBrace(Boolean value)

getCatchOnSameLineAsOpeningBrace

public Boolean getCatchOnSameLineAsOpeningBrace()

setCatchOnSameLineAsOpeningBrace

public void setCatchOnSameLineAsOpeningBrace(Boolean value)

getValidateFinally

public boolean getValidateFinally()

isValidateFinally

public boolean isValidateFinally()

setValidateFinally

public void setValidateFinally(boolean value)

getFinallyOnSameLineAsClosingBrace

public Boolean getFinallyOnSameLineAsClosingBrace()

setFinallyOnSameLineAsClosingBrace

public void setFinallyOnSameLineAsClosingBrace(Boolean value)

getFinallyOnSameLineAsOpeningBrace

public Boolean getFinallyOnSameLineAsOpeningBrace()

setFinallyOnSameLineAsOpeningBrace

public void setFinallyOnSameLineAsOpeningBrace(Boolean value)