com.helger.json.convert.JsonConverter Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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 com.helger.json.convert;

import java.util.Collection;
import java.util.Map;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;

import com.helger.commons.annotation.PresentForCodeCoverage;
import com.helger.commons.collection.ArrayHelper;
import com.helger.commons.typeconvert.TypeConverter;
import com.helger.json.IHasJson;
import com.helger.json.IJson;
import com.helger.json.IJsonArray;
import com.helger.json.IJsonObject;
import com.helger.json.JsonArray;
import com.helger.json.JsonObject;
import com.helger.json.JsonValue;

/**
 * A utility class for converting objects from and to {@link IJson}.
 *
 * @author Philip Helger
 */
@Immutable
public final class JsonConverter
{
  @PresentForCodeCoverage
  private static final JsonConverter INSTANCE = new JsonConverter ();

  private JsonConverter ()
  {}

  /**
   * Convert any Object to an {@link IJson} representation. Supported classes
   * are:
   * 
   * null
   * com.helger.json.IJson
   * com.helger.json.IJsonProvider
   * boolean []
   * byte []
   * char []
   * double []
   * float []
   * int []
   * long []
   * short []
   * Object [] - recursive invocation
   * Collection<?> - recursive invocation
   * Map<?,?> - recursive invocation, key must be a String!
   * 
   * All other objects are put "as is" into {@link JsonValue} objects.
   *
   * @param aObject
   *        Source Object to convert May be null.
   * @return Never null.
   */
  @Nonnull
  public static IJson convertToJson (@Nullable final Object aObject)
  {
    if (aObject == null)
      return JsonValue.NULL;

    if (aObject instanceof IJson)
      return (IJson) aObject;

    if (aObject instanceof IHasJson)
      return ((IHasJson) aObject).getAsJson ();

    if (ArrayHelper.isArray (aObject))
    {
      if (aObject instanceof boolean [])
      {
        final boolean [] aArray = (boolean []) aObject;
        return new JsonArray (aArray.length).addAll (aArray);
      }
      if (aObject instanceof byte [])
      {
        final byte [] aArray = (byte []) aObject;
        return new JsonArray (aArray.length).addAll (aArray);
      }
      if (aObject instanceof char [])
      {
        final char [] aArray = (char []) aObject;
        return new JsonArray (aArray.length).addAll (aArray);
      }
      if (aObject instanceof double [])
      {
        final double [] aArray = (double []) aObject;
        return new JsonArray (aArray.length).addAll (aArray);
      }
      if (aObject instanceof float [])
      {
        final float [] aArray = (float []) aObject;
        return new JsonArray (aArray.length).addAll (aArray);
      }
      if (aObject instanceof int [])
      {
        final int [] aArray = (int []) aObject;
        return new JsonArray (aArray.length).addAll (aArray);
      }
      if (aObject instanceof long [])
      {
        final long [] aArray = (long []) aObject;
        return new JsonArray (aArray.length).addAll (aArray);
      }
      if (aObject instanceof short [])
      {
        final short [] aArray = (short []) aObject;
        return new JsonArray (aArray.length).addAll (aArray);
      }
      if (aObject instanceof Object [])
      {
        final Object [] aArray = (Object []) aObject;
        final IJsonArray aJsonArray = new JsonArray (aArray.length);
        for (final Object aValue : aArray)
        {
          // Recursive conversion
          aJsonArray.add (convertToJson (aValue));
        }
        return aJsonArray;
      }
      throw new IllegalStateException ("Expected an array but got none. Object=" + aObject);
    }

    if (aObject instanceof Collection )
    {
      final Collection  aCollection = (Collection ) aObject;
      final IJsonArray aJsonArray = new JsonArray (aCollection.size ());
      for (final Object aValue : aCollection)
      {
        // Recursive conversion
        aJsonArray.add (convertToJson (aValue));
      }
      return aJsonArray;
    }

    if (aObject instanceof Map )
    {
      final Map  aMap = (Map ) aObject;
      final IJsonObject aJsonObject = new JsonObject (aMap.size ());
      for (final Map.Entry  aEntry : aMap.entrySet ())
      {
        final String sKey = TypeConverter.convert (aEntry.getKey (), String.class);
        if (sKey == null)
          throw new IllegalArgumentException ("Map key '" + aEntry.getKey () + "' could not be converted to a String!");
        // Recursive conversion
        final IJson aValue = convertToJson (aEntry.getValue ());
        aJsonObject.addJson (sKey, aValue);
      }
      return aJsonObject;
    }

    // Assume it is a simple value
    return JsonValue.create (aObject);
  }
}