Commit Graph

35 Commits

Author SHA1 Message Date
Phillip Webb 4b55144d80 Polish 2016-02-19 16:19:22 -08:00
Stephane Nicoll b82fb5e5a6 Merge branch '1.3.x' 2016-02-10 11:44:08 +01:00
Stephane Nicoll 6710c05750 Document `DeprecatedConfigurationProperty`
Closes gh-5118
2016-02-10 11:43:37 +01:00
Stephane Nicoll 34d87df425 Clarify use of the `spring.datasource` prefix
Previously, Spring Boot mapped both `DataSourceProperties` and the actual
`DataSource` implementation to the same prefix. This results in a huge
amount of keys in the `spring.datasource` namespace  with no way to
identify those that are valid for the pooled data source in use.

This commit maps the four pooled data sources we support in four isolated
namespace, keeping `spring.datasource` only for the common settings.

These are `spring.datasource.tomcat`, `spring.datasource.hikari`,
`spring.datasource.dbcp` and `spring.datasource.dbcp2` for the Tomcat,
Hikari, Commons DBCP and Commons DBCP2 implementations respectively.

Closes gh-2183
2016-02-03 11:05:23 +01:00
Johnny Lim 46540de694 Fix typos
Closes gh-5067
2016-02-02 11:19:07 +01:00
Stephane Nicoll 6b4e4e652a Clarify annotation processor config with AspectJ
Closes gh-4847
2016-01-12 15:55:39 +01:00
Johnny Lim 4d9111606b Polish docs
Closes gh-4446
2015-11-12 17:23:04 +01:00
Stephane Nicoll 35875c7f08 Merge manual item meta-data
Previously, manual meta-data were added to the existing set of entries
which could lead to duplicates if a manual entry is meant to complement
a property that is detected via the processor.

We now match the name and type of the item against the auto-detected
entries. If no match is found, we add the extra entry as we did before.
If a match is found we override the description, default value and
deprecation information.

Closes gh-3562
2015-08-20 17:08:54 +02:00
izeye ee6fc8d917 Fix typos
Closes gh-3608
2015-07-28 08:54:47 +02:00
Stephane Nicoll a9737c016c Review doc
Replace server.tomcat.compression example as Boot does no longer define
that property
2015-07-15 17:56:58 +02:00
Stephane Nicoll f75333dce2 Improve doc 2015-07-15 16:00:54 +02:00
izeye f4589e7cc3 Fix typos
Closes gh-3504
2015-07-15 15:45:02 +02:00
Stephane Nicoll f2d32d3e98 Add support for property deprecation
Previously, an item could only have a 'deprecated' boolean flag to
indicate that the property is deprecated. It is desirable to provide an
additional description for the deprecation as well as the name of the
property to use instead.

The `deprecated` boolean flag is now supported. Instead, a `deprecated`
object can be specified with two optional attributes: `reason` to provide
an explanation for the deprecation and `replacement` to refer to the
property that should be used instead. If none of them is present, an
empty deprecation object should be set.

For backward compatibility, the `deprecated` field is still set.

Deprecation information can only set via manual meta-data.

Closes gh-3449
2015-07-15 15:41:52 +02:00
Stephane Nicoll 7ba7693e65 Polish doc
See gh-3457
2015-07-13 13:48:13 +02:00
Stephane Nicoll cb5eccb5c1 Add missing handle-as meta-data
Liquibase has a `changeLog` property that is definitely used as a
`Resource` but cannot be defined as such as the original String value
should be kept against an API we don't control.

Update the tests also to make it more clear that if hints are added
against a property that is detected automatically, said property still
keeps all its auto-discovered capabilities.

Closes gh-3457
2015-07-13 13:45:23 +02:00
Stephane Nicoll 3664895f04 Polish 2015-07-12 09:20:12 +02:00
Stephane Nicoll 1ce418cfdc Fix meta-data for logging.level property 2015-07-10 18:12:24 +02:00
Stephane Nicoll 8ff8afec7c Add "handle-as" hint provider
Replace the enum provider by a more general purpose provider that can
substitute the type of the property for the purpose of auto-completing
the values.

"handle-as" can be used for enums but for any type that the IDE
understands such as locale, charset, mime-type and Spring's resource
abstraction.

Closes gh-3457
2015-07-10 14:28:11 +02:00
Stephane Nicoll c5ae68a1ec Clarify enum provider purpose 2015-07-09 14:38:48 +02:00
Phillip Webb 0cf6efca4f Polish 2015-07-06 13:05:09 -07:00
Stephane Nicoll 2da1d37e97 Add profile name provider 2015-07-06 11:55:35 +02:00
Phillip Webb 7879743b9f Polish 2015-06-25 12:00:48 -07:00
Stephane Nicoll 0ec9de9137 Add support for value provider
Improve the "hints" section of the metadata so that each hint can provide
the reference to a value provider.

A value provider defines how a tool can discover the potential values of
a property based on the context. The provider is identifed by a name and
may have an arbitrary number of parameters.

Closes gh-3303
2015-06-25 14:58:10 +02:00
Phillip Webb 778e3eb091 Polish 2015-06-24 16:15:12 -07:00
Stephane Nicoll bc9321734f Add support for property hint
Create a new section in the meta-data called "hints" where users can
provide hints about a given property. The most basic use case for now
is to provide a list of values that a property can have. Each value may
have a description.

This sample JSON provides a basic example for a property called `foo.mode`
that exposes 3 values: "auto", "basic" and "advanced".

```
 "hints": [
    {
      "id": "foo.mode",
      "values": [
        {
          "value": "auto",
          "description": "Some smart description."
        },
        {
          "name": "basic"
        },
        {
          "name": "advanced"
        }
      ]
    }
]
```

This information can be read by tools (such as IDE) and offer an
auto-completion with the list of values.

Closes gh-2054
2015-06-24 18:53:11 +02:00
Stephane Nicoll 117d6b0da3 Fix typo 2015-06-24 11:12:42 +02:00
Phillip Webb d5a82aaed8 Document "annotation processing with Gradle"
Provide details of how to configure Gradle, including the work-around
require to parse any additional metadata files.

Fixes gh-2316
2015-02-24 20:26:54 -08:00
Stephane Nicoll 20c8e54c5f Revert dea1ca9855
Actually collection types are not harmonized to their interface
counterpart; this was implemented in the first proposal but wasn't
applied in the final review.

See gh-2206
2014-12-20 10:31:11 +01:00
Stephane Nicoll 77427f53cc Support of Lombok annotated ConfigurationProperties
Previously, no configuration properties were discovered on a class using
lombok instead of regular getters/setters.

This commit adds a support for some of the lombok annotations,
specifically that is @Data, @Getter and @Setter. Provides the same
semantic as what lombok is generating.

Closes gh-2114
2014-12-16 10:41:07 +01:00
Stephane Nicoll 509201907c Polish default value for arrays
See gh-1996
2014-12-03 17:32:00 +01:00
Stephane Nicoll f821fdfffa Fix typo 2014-12-03 17:21:56 +01:00
Stephane Nicoll dea1ca9855 Update description of property type 2014-11-24 10:38:13 +01:00
Phillip Webb 182ce21542 Clarify configuration meta-data details
Update the configuration meta-data appendix to clarify a few things.
2014-11-20 10:07:02 -08:00
Stephane Nicoll ab6878ab66 Add documentation for the deprecated field 2014-11-20 18:37:34 +01:00
Phillip Webb 9d01d4fa84 Document configuration meta-data
Add an appendix to the reference documentation describing the format
of configuration meta-data and how the annotation processor can be used.

Closes gh-1001
2014-11-02 21:49:42 -08:00