net.sf.jstuff.integration.yaml.YamlNode Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2010-2022 by Sebastian Thomschke and contributors.
 * SPDX-License-Identifier: EPL-2.0
 */
package net.sf.jstuff.integration.yaml;

import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.Collection;
import java.util.Map;
import java.util.function.Consumer;

import org.eclipse.jdt.annotation.Nullable;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.JsonNodeFactory;
import com.fasterxml.jackson.databind.node.NullNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.fasterxml.jackson.databind.util.RawValue;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;

/**
 * {@link ObjectNode} based YamlNode with improved fluent API.
 *
 * @author Sebastian Thomschke
 */
public final class YamlNode extends ObjectNode {

   private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper(new YAMLFactory() //
      .enable(YAMLGenerator.Feature.MINIMIZE_QUOTES) //
      .enable(YAMLGenerator.Feature.INDENT_ARRAYS) //
      .disable(YAMLGenerator.Feature.SPLIT_LINES) //
      .disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER) //
   );

   private static final long serialVersionUID = 1L;

   public static YamlNode create() {
      return new YamlNode(OBJECT_MAPPER.getNodeFactory());
   }

   private YamlNode(final JsonNodeFactory nc) {
      super(nc);
   }

   public YamlNode compute(final Consumer consumer) {
      consumer.accept(this);
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final @Nullable BigDecimal v) {
      super.put(fieldName, v);
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final @Nullable BigInteger v) {
      super.put(fieldName, v);
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final boolean v) {
      super.put(fieldName, v);
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final @Nullable Boolean v) {
      super.put(fieldName, v);
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final byte @Nullable [] v) {
      super.put(fieldName, v);
      return this;
   }

   /**
    * Method that will set specified field, replacing old value, if any.
    *
    * @param value to set field to; if null, will be converted
    *           to a {@link NullNode} first (to remove field entry, call
    *           {@link #remove} instead)
    *
    * @return This node (to allow chaining)
    */
   @Override
   public YamlNode put(final String fieldName, final @Nullable JsonNode value) {
      set(fieldName, value);
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final double v) {
      super.put(fieldName, v);
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final @Nullable Double v) {
      super.put(fieldName, v);
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final float v) {
      super.put(fieldName, v);
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final @Nullable Float v) {
      super.put(fieldName, v);
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final int v) {
      super.put(fieldName, v);
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final @Nullable Integer v) {
      super.put(fieldName, v);
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final long v) {
      super.put(fieldName, v);
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final @Nullable Long v) {
      super.put(fieldName, v);
      return this;
   }

   public YamlNode put(final String fieldName, final @Nullable Object obj) {
      super.set(fieldName, obj == null ? null : OBJECT_MAPPER.valueToTree(obj));
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final short v) {
      super.put(fieldName, v);
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final @Nullable Short v) {
      super.put(fieldName, v);
      return this;
   }

   @Override
   public YamlNode put(final String fieldName, final @Nullable String v) {
      super.put(fieldName, v);
      return this;
   }

   @Override
   public YamlNode putNull(final String fieldName) {
      super.putNull(fieldName);
      return this;
   }

   @Override
   public YamlNode putPOJO(final String fieldName, final @Nullable Object pojo) {
      super.putPOJO(fieldName, pojo);
      return this;
   }

   @Override
   public YamlNode putRawValue(final String fieldName, final @Nullable RawValue raw) {
      super.putRawValue(fieldName, raw);
      return this;
   }

   @Override
   public YamlNode remove(final Collection fieldNames) {
      super.remove(fieldNames);
      return this;
   }

   /**
    * IMPORTANT: Does NOT return this node for chaining.
    * 
    * {@inheritDoc}
    */
   @Nullable
   @Override
   public JsonNode remove(final @Nullable String fieldName) {
      final JsonNode removedValue = super.remove(fieldName);
      return removedValue;
   }

   @Override
   public YamlNode removeAll() {
      super.removeAll();
      return this;
   }

   /**
    * IMPORTANT: Does NOT return this node for chaining.
    * 
    * {@inheritDoc}
    */
   @Override
   public JsonNode replace(final String fieldName, final @Nullable JsonNode value) {
      final JsonNode replacedValue = super.replace(fieldName, value);
      return replacedValue;
   }

   @Override
   public YamlNode retain(final Collection fieldNames) {
      super.retain(fieldNames);
      return this;
   }

   @Override
   public YamlNode retain(final String... fieldNames) {
      super.retain(fieldNames);
      return this;
   }

   @Override
   @SuppressWarnings("unchecked")
   public YamlNode set(final String fieldName, final @Nullable JsonNode value) {
      super.set(fieldName, value);
      return this;
   }

   @Override
   @SuppressWarnings("unchecked")
   public  T setAll(final Map properties) {
      super.setAll(properties);
      return (T) this;
   }

   @Override
   @SuppressWarnings("unchecked")
   public YamlNode setAll(final ObjectNode other) {
      super.setAll(other);
      return this;
   }

   @Override
   public String toPrettyString() {
      try {
         return OBJECT_MAPPER.writeValueAsString(this);
      } catch (final JsonProcessingException ex) {
         return ex.getClass().getSimpleName() + ": " + ex.getMessage();
      }
   }

   @Override
   public String toString() {
      return toPrettyString();
   }

   @Override
   @SuppressWarnings("unchecked")
   public  T without(final Collection fieldNames) {
      super.without(fieldNames);
      return (T) this;
   }

   @Override
   @SuppressWarnings("unchecked")
   public YamlNode without(final String fieldName) {
      super.without(fieldName);
      return this;
   }
}