org.dominokit.jackson.JsonSerializer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jackson Show documentation
Apt based jackson
The newest version!
/*
 * Copyright 2013 Nicolas Morel
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.dominokit.jackson;

import org.dominokit.jackson.exception.JsonSerializationException;
import org.dominokit.jackson.stream.JsonWriter;

/**
 * Base class for all the serializer. It handles null values and exceptions. The rest is delegated
 * to implementations.
 */
public abstract class JsonSerializer {

  /**
   * Serializes an object into JSON output.
   *
   * @param writer {@link org.dominokit.jackson.stream.JsonWriter} used to write the serialized JSON
   * @param value Object to serialize
   * @param ctx Context for the full serialization process
   * @throws org.dominokit.jackson.exception.JsonSerializationException if an error occurs during
   *     the serialization
   */
  public void serialize(JsonWriter writer, T value, JsonSerializationContext ctx)
      throws JsonSerializationException {
    serialize(writer, value, ctx, ctx.defaultParameters());
  }

  /**
   * Serializes an object into JSON output.
   *
   * @param writer {@link org.dominokit.jackson.stream.JsonWriter} used to write the serialized JSON
   * @param value Object to serialize
   * @param ctx Context for the full serialization process
   * @param params Parameters for this serialization
   * @throws org.dominokit.jackson.exception.JsonSerializationException if an error occurs during
   *     the serialization
   */
  public void serialize(
      JsonWriter writer, T value, JsonSerializationContext ctx, JsonSerializerParameters params)
      throws JsonSerializationException {
    serialize(writer, value, ctx, params, false);
  }

  /**
   * Serializes an object into JSON output.
   *
   * @param writer {@link org.dominokit.jackson.stream.JsonWriter} used to write the serialized JSON
   * @param value Object to serialize
   * @param ctx Context for the full serialization process
   * @param params Parameters for this serialization
   * @param isMapValue indicate if you're serializing a Map value
   * @throws org.dominokit.jackson.exception.JsonSerializationException if an error occurs during
   *     the serialization
   */
  public void serialize(
      JsonWriter writer,
      T value,
      JsonSerializationContext ctx,
      JsonSerializerParameters params,
      boolean isMapValue)
      throws JsonSerializationException {
    if (null != params.getInclude() && !isMapValue) {
      switch (params.getInclude()) {
        case ALWAYS:
          if (null == value) {
            serializeNullValue(writer, ctx, params);
          } else {
            doSerialize(writer, value, ctx, params);
          }
          return;
        case NON_DEFAULT:
          if (isDefault(value)) {
            writer.cancelName();
          } else {
            doSerialize(writer, value, ctx, params);
          }
          return;
        case NON_EMPTY:
          if (isEmpty(value)) {
            writer.cancelName();
          } else {
            doSerialize(writer, value, ctx, params);
          }
          return;
        case NON_NULL:
          if (null == value) {
            writer.cancelName();
          } else {
            doSerialize(writer, value, ctx, params);
          }
          return;
        case NON_ABSENT:
          if (isAbsent(value)) {
            writer.cancelName();
          } else {
            doSerialize(writer, value, ctx, params);
          }
          return;
      }
    }

    if (null == value) {
      if (ctx.isSerializeNulls() || (isMapValue && ctx.isWriteNullMapValues())) {
        serializeNullValue(writer, ctx, params);
      } else {
        writer.cancelName();
      }
    } else {
      doSerialize(writer, value, ctx, params);
    }
  }

  /**
   * Serialize the null value. This method allows children to override the default behaviour.
   *
   * @param writer {@link org.dominokit.jackson.stream.JsonWriter} used to write the serialized JSON
   * @param ctx Context for the full serialization process
   * @param params Parameters for this serialization
   */
  protected void serializeNullValue(
      JsonWriter writer, JsonSerializationContext ctx, JsonSerializerParameters params) {
    writer.nullValue();
  }

  /**
   * isDefault.
   *
   * @param value the value
   * @return true if the value corresponds to the default one
   */
  protected boolean isDefault(T value) {
    return isEmpty(value);
  }

  /**
   * isEmpty.
   *
   * @param value the value
   * @return true if the value is empty
   */
  protected boolean isEmpty(T value) {
    return null == value;
  }

  /**
   * isAbsent.
   *
   * @param value the value
   * @return true if the value is absent
   */
  protected boolean isAbsent(T value) {
    return null == value;
  }

  /**
   * Serializes a non-null object into JSON output.
   *
   * @param writer {@link org.dominokit.jackson.stream.JsonWriter} used to write the serialized JSON
   * @param value Object to serialize
   * @param ctx Context for the full serialization process
   * @param params Parameters for this serialization
   */
  protected abstract void doSerialize(
      JsonWriter writer, T value, JsonSerializationContext ctx, JsonSerializerParameters params);
}