name.remal.prohibited-classes
Plugin class: name.remal.gradle_plugins.plugins.prohibited_classes.ProhibitedClassesPlugin
plugins {
id 'name.remal.prohibited-classes' version '1.5.0'
}
plugins {
id("name.remal.prohibited-classes") version "1.5.0"
}
The plugin applies name.remal.classes-processing
plugin.
This plugin checks that all compiled classes don't use prohibited classes. To register prohibited classes use prohibitedClasses
extension of type ProhibitedClassesExtension
.
You can use full class names either patterns:
pkg.SomeClass
forbids usingpkg.SomeClass
classpkg.*
forbids using all classes frompkg
package and all sub-packagespkg.SomeClass*
forbids usingpkg.SomeClass
class and all classes those names start withpkg.SomeClass
(i.e.pkg.SomeClass$Inner
)
Also you can prohibit all classes from dependencies. Use module
method: module("junit:junit")
prohibits all classes of JUnit 4.
name.remal.gradle_plugins.plugins.prohibited_classes.ProhibitedClassesExtension
¶
Property | Type | Description |
---|---|---|
classNames |
MutableSet<String> |
Prohibited class names and patterns. |
modules |
MutableMap<String, ProhibitedModule> |
Prohibited class names and patterns. |
Method | Description |
---|---|
void add(String className) |
Add class name or pattern in classNames . |
void add(String... classNames) |
Add class names and patterns in classNames . |
void add(Iterable<String> classNames) |
Add class names and patterns in classNames . |
void module(Any notation) |
Prohibits all classes from corresponding to the notation dependency. |
void module(Any notation, Action<ProhibitedModule> configurer) |
Prohibits all classes from corresponding to the notation dependency. And allows to configure prohibiting process. |
void module(Any notation, Closure configurer) |
Prohibits all classes from corresponding to the notation dependency. And allows to configure prohibiting process. |
name.remal.gradle_plugins.plugins.prohibited_classes.ProhibitedModule
¶
| permittedClassNames
| MutableSet<String>
Method | Description |
---|---|
void permit(String className) |
Add class name or pattern in permittedClassNames . |
void permit(String... classNames) |
Add class names and patterns in permittedClassNames . |
void permit(Iterable<String> classNames) |
Add class names and patterns in permittedClassNames . |