Package net.sourceforge.pmd.lang.rule.xpath

Annotation Interface DeprecatedAttribute

@Documented @Retention(RUNTIME) @Target(METHOD) public @interface DeprecatedAttribute
Node attribute getter methods might be annotated with DeprecatedAttribute to mark the attribute as deprecated for XPath. Unlike Deprecated, this annotation does not deprecate the method for java usage.

When used in combination with Deprecated, this attribute allows specifying a replacement for the XPath attribute.

Since:
6.21.0

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    replaceWith
    An XPath expression to suggest as a replacement for use of the deprecated attribute.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NO_REPLACEMENT
    Sentinel expressing that the attribute is deprecated without replacement.

  • Field Details

    • NO_REPLACEMENT

      static final String NO_REPLACEMENT
      Sentinel expressing that the attribute is deprecated without replacement.
      See Also:

  • Element Details

    • replaceWith

      String replaceWith
      An XPath expression to suggest as a replacement for use of the deprecated attribute. If empty, then the attribute is deprecated for removal. Example values: @NewerAttribute, NodeType/@SomeAttribute, some-function().
      Default:
      ""