PackageNameRule (CodeNarc 3.0.1 API)

Summary:
Property
Constructor

| Detail:
Property
Constructor

org.codenarc.rule.naming.PackageNameRule

```
class PackageNameRule
extends AbstractAstVisitorRule
```
Rule that verifies that the package name of a class matches a regular expression. By default it checks that the package name consists of only lowercase letters and numbers, separated by periods.
The regex property specifies the regular expression to check the package name against. It is required and cannot be null or empty. It defaults to '[a-z]+[a-z0-9]*(\.[a-z0-9]+)*'.
The packageNameRequired property indicates whether a package name declaration is required for all classes. It defaults to false.
Authors:
Chris Mair
Hamlet D'Arcy

Inherited fields
Fields inherited from class	Fields
`class AbstractAstVisitorRule`	`CLOSURE_TEXT, DEFAULT_CONST_NAME, DEFAULT_FIELD_NAME, DEFAULT_TEST_CLASS_NAMES, DEFAULT_TEST_FILES, DEFAULT_VAR_NAME`

Properties Summary

Properties
Type	Name and description
`java.lang.Class`	`astVisitorClass`
`java.lang.String`	`name`
`boolean`	`packageNameRequired`
`int`	`priority`
`java.lang.String`	`regex`

Constructor Summary

Constructors
Constructor and description
`PackageNameRule ()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractAstVisitorRule`	`applyTo, compare, getApplyToClassNames, getAstVisitor, getAstVisitorClass, getDoNotApplyToClassNames, setApplyToClassNames, setDoNotApplyToClassNames, shouldApplyThisRuleTo`
`class AbstractRule`	`applyTo, applyTo, createViolation, createViolation, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getCompilerPhase, getDescription, getDoNotApplyToFileNames, getDoNotApplyToFilesMatching, getName, getPriority, getViolationMessage, isEnabled, isReady, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setName, setPriority, setViolationMessage, toString, validate`

- Property Detail
  - java.lang.Class astVisitorClass
  - java.lang.String name
  - boolean packageNameRequired
  - int priority
  - java.lang.String regex
- Constructor Detail
  - PackageNameRule()

Summary:
Property
Constructor

| Detail:
Property
Constructor

Groovy Documentation