Index (spring-boot-properties-migrator-gradle-plugin 0.3.0 API)

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

A

AbstractMigrationTask - Class in com.patbaumgartner.spring.migrator.gradle: Shared behaviour of the analyze and migrate tasks.
AbstractMigrationTask() - Constructor for class com.patbaumgartner.spring.migrator.gradle.AbstractMigrationTask
advice() - Method in record class com.patbaumgartner.spring.migrator.core.MigrationChange: Returns the value of the advice record component.
analyze() - Method in class com.patbaumgartner.spring.migrator.gradle.AnalyzeTask: Reports deprecated properties found in the project.
AnalyzeTask - Class in com.patbaumgartner.spring.migrator.gradle: Reports deprecated Spring Boot configuration properties without changing any file.
AnalyzeTask() - Constructor for class com.patbaumgartner.spring.migrator.gradle.AnalyzeTask
ANY - Enum constant in enum class com.patbaumgartner.spring.migrator.core.FailurePolicy: Fail when any deprecated property is present, including ones that were or could be migrated automatically.
apply(MigrationPlan) - Method in class com.patbaumgartner.spring.migrator.core.MigrationEngine: Writes every pending change from a plan.
apply(Project) - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorPlugin

C

changes() - Method in class com.patbaumgartner.spring.migrator.core.MigrationPlan: Returns every finding, in file and line order.
changes(Outcome) - Method in class com.patbaumgartner.spring.migrator.core.MigrationPlan: Returns the findings with a given outcome.
changesType(String, String) - Method in class com.patbaumgartner.spring.migrator.core.DeprecationCatalog: Returns whether migrating from to to is known to change the value type, which means the existing value is unlikely to remain valid.
com.patbaumgartner.spring.migrator.core - package com.patbaumgartner.spring.migrator.core
com.patbaumgartner.spring.migrator.gradle - package com.patbaumgartner.spring.migrator.gradle

D

defaultIncludes() - Static method in class com.patbaumgartner.spring.migrator.core.PropertyFileScanner: Returns the default patterns, covering Spring Boot's conventional configuration file locations for main and test resources.
DeprecatedProperty - Record Class in com.patbaumgartner.spring.migrator.core: A deprecated configuration property as described by Spring Boot configuration metadata.
DeprecatedProperty(String, String, String) - Constructor for record class com.patbaumgartner.spring.migrator.core.DeprecatedProperty: Creates a deprecation whose level the metadata did not state.
DeprecatedProperty(String, String, String, Deprecation.Level) - Constructor for record class com.patbaumgartner.spring.migrator.core.DeprecatedProperty: Creates an instance of a DeprecatedProperty record class.
DeprecationCatalog - Class in com.patbaumgartner.spring.migrator.core: The set of deprecated properties known to the configuration metadata on a project's classpath, indexed so that lookups honour Spring Boot's relaxed binding.
deprecationCount() - Method in class com.patbaumgartner.spring.migrator.core.DeprecationCatalog: Returns how many deprecated properties the catalog knows about.
deprecations() - Method in class com.patbaumgartner.spring.migrator.core.MigrationPlan: Returns every deprecation finding, excluding keys that are merely absent from the metadata.
describesNamespace(String) - Method in class com.patbaumgartner.spring.migrator.core.DeprecationCatalog: Returns whether the metadata describes at least one property in a namespace.
describeViolation(MigrationPlan) - Method in enum class com.patbaumgartner.spring.migrator.core.FailurePolicy: Describes why the policy was violated.
describeViolation(MigrationPlan) - Method in enum class com.patbaumgartner.spring.migrator.core.UnknownKeyPolicy: Describes why the policy was violated.
diagnostics() - Method in class com.patbaumgartner.spring.migrator.core.MigrationPlan: Returns messages about conditions that make the result less trustworthy, such as unreadable files or an empty metadata repository.
disabled() - Static method in record class com.patbaumgartner.spring.migrator.core.UnknownKeyOptions: Returns options that switch the check off, which is the default.

E

empty() - Static method in class com.patbaumgartner.spring.migrator.core.DeprecationCatalog: Returns an empty catalog, used when no metadata could be resolved.
equals(Object) - Method in record class com.patbaumgartner.spring.migrator.core.DeprecatedProperty: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.patbaumgartner.spring.migrator.core.MigrationChange: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.patbaumgartner.spring.migrator.core.PropertyFileScanner.ScanResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.patbaumgartner.spring.migrator.core.UnknownKeyOptions: Indicates whether some other object is "equal to" this one.
excludes() - Method in record class com.patbaumgartner.spring.migrator.core.UnknownKeyOptions: Returns the value of the excludes record component.

F

FAIL - Enum constant in enum class com.patbaumgartner.spring.migrator.core.UnknownKeyPolicy: Report unrecognised keys and fail the build when any remains.
FailurePolicy - Enum Class in com.patbaumgartner.spring.migrator.core: When a migration run should fail the build.
file() - Method in record class com.patbaumgartner.spring.migrator.core.MigrationChange: Returns the value of the file record component.
files() - Method in record class com.patbaumgartner.spring.migrator.core.PropertyFileScanner.ScanResult: Returns the value of the files record component.
find(String) - Method in class com.patbaumgartner.spring.migrator.core.DeprecationCatalog: Looks up a deprecated property, honouring relaxed binding so that server.maxHttpHeaderSize matches server.max-http-header-size.
from(Map<String, ConfigurationMetadataProperty>) - Static method in class com.patbaumgartner.spring.migrator.core.DeprecationCatalog: Builds a catalog from raw configuration metadata properties.

G

getClasspath() - Method in class com.patbaumgartner.spring.migrator.gradle.AbstractMigrationTask: Returns the classpath whose entries are searched for configuration metadata.
getDryRun() - Method in class com.patbaumgartner.spring.migrator.gradle.AbstractMigrationTask: Returns whether the migrate task should report without writing anything.
getFailOn() - Method in class com.patbaumgartner.spring.migrator.gradle.AbstractMigrationTask: Returns when the build should fail: never, manual or any.
getFailOn() - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Returns when the build should fail: never, manual when a finding needs a human, or any for any deprecated property at all.
getIncludes() - Method in class com.patbaumgartner.spring.migrator.gradle.AbstractMigrationTask: Returns the glob patterns selecting the configuration files to inspect.
getIncludes() - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Returns the glob patterns, relative to the project directory, selecting the configuration files to inspect.
getProjectDirectory() - Method in class com.patbaumgartner.spring.migrator.gradle.AbstractMigrationTask: Returns the project directory that include patterns are relative to.
getReportFile() - Method in class com.patbaumgartner.spring.migrator.gradle.AbstractMigrationTask: Returns the optional report path, relative to the project directory.
getReportFile() - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Returns the optional file, relative to the project directory, to write the report to.
getSpringBootVersion() - Method in class com.patbaumgartner.spring.migrator.gradle.AbstractMigrationTask: Returns the Spring Boot version shown in the report.
getSpringBootVersion() - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Returns the Spring Boot version shown in the report.
getUnknownKeyExcludes() - Method in class com.patbaumgartner.spring.migrator.gradle.AbstractMigrationTask: Returns the exact keys or prefixes never to report as unrecognised.
getUnknownKeyExcludes() - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Returns the exact keys or prefixes never to report as unrecognised.
getUnknownKeyIncludes() - Method in class com.patbaumgartner.spring.migrator.gradle.AbstractMigrationTask: Returns the namespaces to inspect for unrecognised keys instead of the defaults.
getUnknownKeyIncludes() - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Returns the namespaces to inspect for unrecognised keys instead of the Spring Boot ones the check defaults to.
getUnknownKeys() - Method in class com.patbaumgartner.spring.migrator.gradle.AbstractMigrationTask: Returns whether to report configuration keys that no metadata describes: off, report or fail.
getUnknownKeys() - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Returns whether to report configuration keys that no metadata on the resolved classpath describes: off, report, or fail.

H

hasFindings() - Method in class com.patbaumgartner.spring.migrator.core.MigrationPlan: Returns whether any deprecated property was found.
hashCode() - Method in record class com.patbaumgartner.spring.migrator.core.DeprecatedProperty: Returns a hash code value for this object.
hashCode() - Method in record class com.patbaumgartner.spring.migrator.core.MigrationChange: Returns a hash code value for this object.
hashCode() - Method in record class com.patbaumgartner.spring.migrator.core.PropertyFileScanner.ScanResult: Returns a hash code value for this object.
hashCode() - Method in record class com.patbaumgartner.spring.migrator.core.UnknownKeyOptions: Returns a hash code value for this object.
hasPendingWrites() - Method in class com.patbaumgartner.spring.migrator.core.MigrationPlan: Returns whether applying the plan would modify any file.
hasReplacement() - Method in record class com.patbaumgartner.spring.migrator.core.DeprecatedProperty: Returns whether the metadata names a property to migrate to.

I

includes() - Method in record class com.patbaumgartner.spring.migrator.core.UnknownKeyOptions: Returns the value of the includes record component.
isDryRun() - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Returns whether the migrate task should report without writing anything.
isEmpty() - Method in class com.patbaumgartner.spring.migrator.core.DeprecationCatalog: Returns whether the catalog holds no metadata at all, which usually means the project classpath could not be resolved rather than that the project is clean.
isEnabled() - Method in enum class com.patbaumgartner.spring.migrator.core.UnknownKeyPolicy: Returns whether the detector should run.
isKnown(String) - Method in class com.patbaumgartner.spring.migrator.core.DeprecationCatalog: Returns whether the metadata describes the given key, honouring the fact that aggregate properties are declared at their prefix rather than per entry.
isRemoved() - Method in record class com.patbaumgartner.spring.migrator.core.DeprecatedProperty: Returns whether the property is already removed rather than merely discouraged.
isViolatedBy(MigrationPlan) - Method in enum class com.patbaumgartner.spring.migrator.core.FailurePolicy: Returns whether the plan violates this policy.
isViolatedBy(MigrationPlan) - Method in enum class com.patbaumgartner.spring.migrator.core.UnknownKeyPolicy: Returns whether the plan violates this policy.

K

key() - Method in record class com.patbaumgartner.spring.migrator.core.DeprecatedProperty: Returns the value of the key record component.
key() - Method in record class com.patbaumgartner.spring.migrator.core.MigrationChange: Returns the value of the key record component.

L

level() - Method in record class com.patbaumgartner.spring.migrator.core.DeprecatedProperty: Returns the value of the level record component.
line() - Method in record class com.patbaumgartner.spring.migrator.core.MigrationChange: Returns the value of the line record component.
load(Collection<Path>) - Static method in class com.patbaumgartner.spring.migrator.core.MetadataRepositoryLoader: Reads the configuration metadata contained in the given classpath entries.

M

MANUAL - Enum constant in enum class com.patbaumgartner.spring.migrator.core.FailurePolicy: Fail when a finding needs a human, either because migrating it is not provably safe or because the property has no replacement at all.
MANUAL - Enum constant in enum class com.patbaumgartner.spring.migrator.core.Outcome: A replacement exists but applying it automatically is not provably safe, so the key was left untouched and reported instead.
MetadataRepositoryLoader - Class in com.patbaumgartner.spring.migrator.core: Collects Spring Boot configuration metadata from a resolved classpath.
migrate() - Method in class com.patbaumgartner.spring.migrator.gradle.MigrateTask: Rewrites the deprecated properties that can be migrated safely.
MIGRATED - Enum constant in enum class com.patbaumgartner.spring.migrator.core.Outcome: The key was rewritten to its replacement, or would be when not running dry.
MigrateTask - Class in com.patbaumgartner.spring.migrator.gradle: Rewrites deprecated Spring Boot configuration properties in place.
MigrateTask() - Constructor for class com.patbaumgartner.spring.migrator.gradle.MigrateTask
MigrationChange - Record Class in com.patbaumgartner.spring.migrator.core: One deprecated property found in one configuration file.
MigrationChange(String, int, String, String, Outcome, String, String) - Constructor for record class com.patbaumgartner.spring.migrator.core.MigrationChange: Creates an instance of a MigrationChange record class.
MigrationEngine - Class in com.patbaumgartner.spring.migrator.core: Plans and applies migrations of deprecated Spring Boot configuration properties.
MigrationEngine() - Constructor for class com.patbaumgartner.spring.migrator.core.MigrationEngine
MigrationPlan - Class in com.patbaumgartner.spring.migrator.core: The outcome of analysing a project: every deprecated property that was found, why the migrator classified it the way it did, and the exact file content that would be written if the plan is applied.

N

names() - Static method in enum class com.patbaumgartner.spring.migrator.core.FailurePolicy: Returns the accepted values, for use in error messages.
names() - Static method in enum class com.patbaumgartner.spring.migrator.core.UnknownKeyPolicy: Returns the accepted values, for use in error messages.
NEVER - Enum constant in enum class com.patbaumgartner.spring.migrator.core.FailurePolicy: Report findings but always succeed.

O

OFF - Enum constant in enum class com.patbaumgartner.spring.migrator.core.UnknownKeyPolicy: Do not look for unrecognised keys at all.
outcome() - Method in record class com.patbaumgartner.spring.migrator.core.MigrationChange: Returns the value of the outcome record component.
Outcome - Enum Class in com.patbaumgartner.spring.migrator.core: What the migrator decided to do about a deprecated property it found.

P

parse(String) - Static method in enum class com.patbaumgartner.spring.migrator.core.FailurePolicy: Parses a policy name, ignoring case and surrounding whitespace.
parse(String) - Static method in enum class com.patbaumgartner.spring.migrator.core.UnknownKeyPolicy: Parses a policy name, ignoring case and surrounding whitespace.
plan(Path, List<Path>, DeprecationCatalog, String) - Method in class com.patbaumgartner.spring.migrator.core.MigrationEngine: Analyses the given files without modifying anything.
plan(Path, List<Path>, DeprecationCatalog, String, UnknownKeyOptions) - Method in class com.patbaumgartner.spring.migrator.core.MigrationEngine: Analyses the given files without modifying anything.
policy() - Method in record class com.patbaumgartner.spring.migrator.core.UnknownKeyOptions: Returns the value of the policy record component.
PropertyFileScanner - Class in com.patbaumgartner.spring.migrator.core: Finds the configuration files a migration should look at.
PropertyFileScanner.ScanResult - Record Class in com.patbaumgartner.spring.migrator.core: The files a scan found, together with anything that stopped it from looking.

R

reason() - Method in record class com.patbaumgartner.spring.migrator.core.DeprecatedProperty: Returns the value of the reason record component.
reason() - Method in record class com.patbaumgartner.spring.migrator.core.MigrationChange: Returns the value of the reason record component.
render(boolean) - Method in class com.patbaumgartner.spring.migrator.core.MigrationPlan: Renders a human-readable report.
replacement() - Method in record class com.patbaumgartner.spring.migrator.core.DeprecatedProperty: Returns the value of the replacement record component.
replacement() - Method in record class com.patbaumgartner.spring.migrator.core.MigrationChange: Returns the value of the replacement record component.
REPORT - Enum constant in enum class com.patbaumgartner.spring.migrator.core.UnknownKeyPolicy: Report unrecognised keys without ever failing the build.
resolveReplacement(DeprecatedProperty) - Method in class com.patbaumgartner.spring.migrator.core.DeprecationCatalog: Follows chained deprecations to the property a user should end up with.
runMigration(boolean) - Method in class com.patbaumgartner.spring.migrator.gradle.AbstractMigrationTask: Analyses the project and, when asked to and allowed to, writes the result.

S

scan(Path, List<String>) - Static method in class com.patbaumgartner.spring.migrator.core.PropertyFileScanner: Scans a project for files matching the given glob patterns.
ScanResult(List<Path>, List<String>) - Constructor for record class com.patbaumgartner.spring.migrator.core.PropertyFileScanner.ScanResult: Creates an instance of a ScanResult record class.
setDryRun(boolean) - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Sets whether the migrate task should report without writing anything.
setFailOn(String) - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Sets when the build should fail.
setIncludes(List<String>) - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Sets the glob patterns selecting the configuration files to inspect.
setReportFile(String) - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Sets the file to write the report to.
setSpringBootVersion(String) - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Sets the Spring Boot version shown in the report.
setUnknownKeyExcludes(List<String>) - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Sets the exact keys or prefixes never to report as unrecognised.
setUnknownKeyIncludes(List<String>) - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Sets the namespaces to inspect for unrecognised keys.
setUnknownKeys(String) - Method in class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension: Sets whether to report keys the metadata does not describe.
SpringBootPropertiesMigratorExtension - Class in com.patbaumgartner.spring.migrator.gradle: Project-wide configuration for the analyze and migrate tasks.
SpringBootPropertiesMigratorExtension() - Constructor for class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorExtension
SpringBootPropertiesMigratorPlugin - Class in com.patbaumgartner.spring.migrator.gradle: Registers the analyze and migrate tasks and wires them to the project's configuration.
SpringBootPropertiesMigratorPlugin() - Constructor for class com.patbaumgartner.spring.migrator.gradle.SpringBootPropertiesMigratorPlugin

T

toString() - Method in record class com.patbaumgartner.spring.migrator.core.DeprecatedProperty: Returns a string representation of this record class.
toString() - Method in record class com.patbaumgartner.spring.migrator.core.MigrationChange: Returns a string representation of this record class.
toString() - Method in record class com.patbaumgartner.spring.migrator.core.PropertyFileScanner.ScanResult: Returns a string representation of this record class.
toString() - Method in record class com.patbaumgartner.spring.migrator.core.UnknownKeyOptions: Returns a string representation of this record class.
typeOf(String) - Method in class com.patbaumgartner.spring.migrator.core.DeprecationCatalog: Returns the declared type of a property, when the metadata knows it.

U

UNKNOWN - Enum constant in enum class com.patbaumgartner.spring.migrator.core.Outcome: No metadata on the resolved classpath describes the key at all.
UnknownKeyOptions - Record Class in com.patbaumgartner.spring.migrator.core: How a run should treat configuration keys that no metadata describes.
UnknownKeyOptions(UnknownKeyPolicy, List<String>, List<String>) - Constructor for record class com.patbaumgartner.spring.migrator.core.UnknownKeyOptions: Defensively copies the lists and accepts null for either, so that a build tool that leaves an unset list parameter alone behaves like one that sets it empty.
UnknownKeyPolicy - Enum Class in com.patbaumgartner.spring.migrator.core: What to do about configuration keys that no metadata on the project classpath describes.
UNSUPPORTED - Enum constant in enum class com.patbaumgartner.spring.migrator.core.Outcome: The property is deprecated and the metadata names no replacement.

V

valueOf(String) - Static method in enum class com.patbaumgartner.spring.migrator.core.FailurePolicy: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.patbaumgartner.spring.migrator.core.Outcome: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.patbaumgartner.spring.migrator.core.UnknownKeyPolicy: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.patbaumgartner.spring.migrator.core.FailurePolicy: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.patbaumgartner.spring.migrator.core.Outcome: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.patbaumgartner.spring.migrator.core.UnknownKeyPolicy: Returns an array containing the constants of this enum class, in the order they are declared.

W

warnings() - Method in record class com.patbaumgartner.spring.migrator.core.PropertyFileScanner.ScanResult: Returns the value of the warnings record component.

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