S1874 FP "@Deprecated" code should not be used java:S1874, in ObjectNode

Eduardo_Ito · September 12, 2023, 3:16pm

False positive with rule java:S1874 “@ Deprecated” code should not be used

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.15.2</version>
</dependency>

In class com.fasterxml.jackson.databind.node.ObjectNode the put method with JsonNode as value is deprecated:

public JsonNode put(String propertyName, JsonNode value)

github.com

FasterXML/jackson-databind/blob/3e4ab840d940d3378258c2ac20d6ca4d8e5cd64b/src/main/java/com/fasterxml/jackson/databind/node/ObjectNode.java#L680


      
           * @param value Value to set to property; if null, will be converted
           *   to a {@link NullNode} first  (to remove a property, call
           *   {@link #remove} instead).
           *
           * @return Old value of the property, if any; {@code null} if there was no
           *   old value.
           *
           * @deprecated Since 2.4 use either {@link #set(String,JsonNode)} or {@link #replace(String,JsonNode)},
           */
          @Deprecated
          public JsonNode put(String propertyName, JsonNode value)
          {
              if (value == null) { // let's not store 'raw' nulls but nodes
                  value = nullNode();
              }
              return _children.put(propertyName, value);
          }
          
          /**
           * Method that will set value of specified property if (and only if)
           * it had no set value previously.

But all other put methods are not, like this one with a String value:

public ObjectNode put(String fieldName, String v)

github.com

FasterXML/jackson-databind/blob/3e4ab840d940d3378258c2ac20d6ca4d8e5cd64b/src/main/java/com/fasterxml/jackson/databind/node/ObjectNode.java#L1038


      
          public ObjectNode put(String fieldName, BigInteger v) {
              return _put(fieldName, (v == null) ? nullNode()
                      : numberNode(v));
          }
          
          /**
           * Method for setting value of a field to specified String value.
           *
           * @return This node (to allow chaining)
           */
          public ObjectNode put(String fieldName, String v) {
              return _put(fieldName, (v == null) ? nullNode()
                      : textNode(v));
          }
          
          /**
           * Method for setting value of a field to specified String value.
           *
           * @return This node (to allow chaining)
           */
          public ObjectNode put(String fieldName, boolean v) {

Example:

ObjectNode node = new ObjectMapper().createObjectNode();
node.put("field", "value");

SonarQube Enterprise generates an issue ‘Remove this use of “put”; it is deprecated.’ but the put method with a String value is not deprecated.

–
Eduardo Ito.

Colin · September 13, 2023, 1:33am

Hey there.

What version of SonarQube are you using? You should be able to find this in the footer of your SonarQube instance.