Index

A C D E F G H I K L P S T U V
All Classes and Interfaces|All Packages

A

analyze() - Method in class io.github.timoIpeters.custompropertyanalyzer.AnalyzeCustomPropertiesTask

Task action that drives the full property analysis.

AnalyzeCustomPropertiesTask - Class in io.github.timoIpeters.custompropertyanalyzer

Analyzes a Spring Boot project's Java source files to discover all custom properties defined via @Value and @ConfigurationProperties annotations.

AnalyzeCustomPropertiesTask() - Constructor for class io.github.timoIpeters.custompropertyanalyzer.AnalyzeCustomPropertiesTask

apply(Project) - Method in class io.github.timoIpeters.custompropertyanalyzer.CustomPropertyAnalyzerPlugin

C

check() - Method in class io.github.timoIpeters.custompropertyanalyzer.CheckUnusedPropertiesTask

Task action that compares defined configuration keys against code-referenced keys and flags any that are unused.

CheckUnusedPropertiesTask - Class in io.github.timoIpeters.custompropertyanalyzer

Checks for properties that are defined in configuration files but never referenced in the project's Java source code.

CheckUnusedPropertiesTask() - Constructor for class io.github.timoIpeters.custompropertyanalyzer.CheckUnusedPropertiesTask

CONFIGURATION_PROPERTIES - Enum constant in enum class io.github.timoIpeters.custompropertyanalyzer.PropertySource

The property was discovered by expanding the fields of a class annotated with @ConfigurationProperties.

CustomPropertyAnalyzerPlugin - Class in io.github.timoIpeters.custompropertyanalyzer

Entry point for the Custom Property Analyzer Gradle plugin.

CustomPropertyAnalyzerPlugin() - Constructor for class io.github.timoIpeters.custompropertyanalyzer.CustomPropertyAnalyzerPlugin

D

defaultValue() - Method in record class io.github.timoIpeters.custompropertyanalyzer.PropertyInfo

Returns the value of the defaultValue record component.

E

equals(Object) - Method in record class io.github.timoIpeters.custompropertyanalyzer.PropertyInfo

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.timoIpeters.custompropertyanalyzer.UnusedProperty

Indicates whether some other object is "equal to" this one.

F

fullPath() - Method in record class io.github.timoIpeters.custompropertyanalyzer.PropertyInfo

Returns the value of the fullPath record component.

G

getAdditionalPropertiesPattern() - Method in class io.github.timoIpeters.custompropertyanalyzer.AnalyzeCustomPropertiesTask

Glob pattern for additional property files to include in default value resolution, beyond the baseline application.properties, application.yml, and application.yaml.

getAdditionalPropertiesPattern() - Method in class io.github.timoIpeters.custompropertyanalyzer.CheckUnusedPropertiesTask

Glob pattern for additional property files to include when scanning for unused keys, beyond the baseline application.properties, application.yml, and application.yaml.

getAnalysisReportFile() - Method in class io.github.timoIpeters.custompropertyanalyzer.CheckUnusedPropertiesTask

The name of the analysis report file produced by analyzeCustomProperties to read referenced property keys from.

getAnalysisReportFileProvider() - Method in class io.github.timoIpeters.custompropertyanalyzer.CheckUnusedPropertiesTask

The analysis report file produced by analyzeCustomProperties, used as input to determine which property keys are referenced in code.

getDisplayName() - Method in enum class io.github.timoIpeters.custompropertyanalyzer.PropertySource

Returns a human-readable label for this source, used in console output when running the analysis task with --verbose.

getIgnoreUnused() - Method in class io.github.timoIpeters.custompropertyanalyzer.CheckUnusedPropertiesTask

Whether to suppress build failure when unused properties are found.

getOutputFile() - Method in class io.github.timoIpeters.custompropertyanalyzer.AnalyzeCustomPropertiesTask

The name of the generated JSON report file.

getOutputFile() - Method in class io.github.timoIpeters.custompropertyanalyzer.CheckUnusedPropertiesTask

The name of the generated JSON report file listing unused properties.

getReportFile() - Method in class io.github.timoIpeters.custompropertyanalyzer.AnalyzeCustomPropertiesTask

The output file to which the JSON property report is written.

getReportFile() - Method in class io.github.timoIpeters.custompropertyanalyzer.CheckUnusedPropertiesTask

The output file to which the unused properties JSON report is written.

getVerboseMode() - Method in class io.github.timoIpeters.custompropertyanalyzer.AnalyzeCustomPropertiesTask

Whether to print the full analysis results to the console in addition to the JSON report.

getVerboseMode() - Method in class io.github.timoIpeters.custompropertyanalyzer.CheckUnusedPropertiesTask

Whether to print the full unused properties results to the console in addition to the JSON report.

H

hashCode() - Method in record class io.github.timoIpeters.custompropertyanalyzer.PropertyInfo

Returns a hash code value for this object.

hashCode() - Method in record class io.github.timoIpeters.custompropertyanalyzer.UnusedProperty

Returns a hash code value for this object.

I

io.github.timoIpeters.custompropertyanalyzer - package io.github.timoIpeters.custompropertyanalyzer

K

key() - Method in record class io.github.timoIpeters.custompropertyanalyzer.UnusedProperty

Returns the value of the key record component.

L

location() - Method in record class io.github.timoIpeters.custompropertyanalyzer.PropertyInfo

Returns the value of the location record component.

P

PropertyInfo - Record Class in io.github.timoIpeters.custompropertyanalyzer

Represents a single custom property discovered during analysis of a Spring Boot project.

PropertyInfo(String, String, PropertySource, String) - Constructor for record class io.github.timoIpeters.custompropertyanalyzer.PropertyInfo

Creates an instance of a PropertyInfo record class.

PropertySource - Enum Class in io.github.timoIpeters.custompropertyanalyzer

Describes how a custom property was discovered during source analysis.

S

setAdditionalPropertiesPattern(String) - Method in class io.github.timoIpeters.custompropertyanalyzer.AnalyzeCustomPropertiesTask

Option to set an additional properties glob pattern

setAdditionalPropertiesPattern(String) - Method in class io.github.timoIpeters.custompropertyanalyzer.CheckUnusedPropertiesTask

Option to set an additional properties glob pattern

setAnalysisReportFile(String) - Method in class io.github.timoIpeters.custompropertyanalyzer.CheckUnusedPropertiesTask

Option to set a custom analysis report file name

setIgnoreUnused(boolean) - Method in class io.github.timoIpeters.custompropertyanalyzer.CheckUnusedPropertiesTask

Option to enable/disable build failure when unused properties are detected

setOutputFile(String) - Method in class io.github.timoIpeters.custompropertyanalyzer.AnalyzeCustomPropertiesTask

Option to set a custom output file

setOutputFile(String) - Method in class io.github.timoIpeters.custompropertyanalyzer.CheckUnusedPropertiesTask

Option to set a custom output file name

setVerboseMode(boolean) - Method in class io.github.timoIpeters.custompropertyanalyzer.AnalyzeCustomPropertiesTask

Option to enable/disable verbose mode

setVerboseMode(boolean) - Method in class io.github.timoIpeters.custompropertyanalyzer.CheckUnusedPropertiesTask

Option to enable/disable verbose console outputs

source() - Method in record class io.github.timoIpeters.custompropertyanalyzer.PropertyInfo

Returns the value of the source record component.

T

toString() - Method in record class io.github.timoIpeters.custompropertyanalyzer.PropertyInfo

Returns a string representation of this record class.

toString() - Method in record class io.github.timoIpeters.custompropertyanalyzer.UnusedProperty

Returns a string representation of this record class.

U

UnusedProperty - Record Class in io.github.timoIpeters.custompropertyanalyzer

Represents a property, which has not been defined in the project properties but is not used in the code

UnusedProperty(String, String) - Constructor for record class io.github.timoIpeters.custompropertyanalyzer.UnusedProperty

Creates an instance of a UnusedProperty record class.

V

value() - Method in record class io.github.timoIpeters.custompropertyanalyzer.UnusedProperty

Returns the value of the value record component.

VALUE_ANNOTATION - Enum constant in enum class io.github.timoIpeters.custompropertyanalyzer.PropertySource

The property was discovered via a @Value("${my.property}") annotation on a field or constructor parameter.

valueOf(String) - Static method in enum class io.github.timoIpeters.custompropertyanalyzer.PropertySource

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.github.timoIpeters.custompropertyanalyzer.PropertySource

Returns an array containing the constants of this enum class, in the order they are declared.

A C D E F G H I K L P S T U V
All Classes and Interfaces|All Packages