Skip to content

Commit

Permalink
[core] PropertyTypeId and PropertyDescriptor#getTypeId
Browse files Browse the repository at this point in the history
Both stay Internal API, update javadoc

Refs pmd#4348
  • Loading branch information
adangel committed Jan 27, 2024
1 parent db0392c commit 217f0f4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ public PropertySerializer<T> serializer() {
* Returns the type ID which was used to define this property. Returns
* null if this property was defined in Java code and not in XML. This
* is used to write the property back to XML, when using a {@link RuleSetWriter}.
*
* @apiNote Internal API
*/
@InternalApi
public @Nullable PropertyTypeId getTypeId() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@
* of the property that should be built. The mapping between the values of this attribute
* and the concrete property that is built is encoded in the constants of this enum.
*
* <h1>Properties API changes</h1>This class' API is mainly provided to build GUIs for XPath rules
* <p>This class' API is mainly provided to build GUIs for XPath rules
* like the rule designer, so that they have info about the available properties from XML. As such,
* the number of clients are probably low. Nevertheless, a bunch of members have been deprecated to
* warn about probable upcoming API changes with 7.0.0, but the amount of change may be greater.
* See {@link PropertyDescriptor} for more info about property framework changes with 7.0.0.
* the number of clients are probably low. Fow now, this stays as Internal API and might be
* changed.
*
* @author Clément Fournier
* @since 6.0.0
* @apiNote Internal API
*/
@InternalApi
public enum PropertyTypeId {
Expand Down

0 comments on commit 217f0f4

Please sign in to comment.