com.helger.commons.serialize.convert.SerializationConverter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation
Java 1.8+ Library with tons of utility classes required in all projects
There is a newer version: 11.1.10
/*
 * 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.commons.serialize.convert;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;

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

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.PresentForCodeCoverage;
import com.helger.commons.lang.GenericReflection;
import com.helger.commons.typeconvert.TypeConverterException;
import com.helger.commons.typeconvert.TypeConverterException.EReason;

/**
 * A utility class for converting objects from and to serializable format.

 * All converters are registered in the {@link SerializationConverterRegistry}.
 *
 * @author Philip Helger
 */
@ThreadSafe
public final class SerializationConverter
{
  @PresentForCodeCoverage
  private static final SerializationConverter INSTANCE = new SerializationConverter ();

  private SerializationConverter ()
  {}

  public static  void writeConvertedObject (@Nullable final T aObject, @Nonnull final ObjectOutputStream aOOS) throws IOException
  {
    ValueEnforcer.notNull (aOOS, "ObjectOutputStream");

    // Write boolean flag indicating null or not
    aOOS.writeBoolean (aObject == null);
    if (aObject != null)
    {
      // Lookup converter
      final Class  aSrcClass = GenericReflection.uncheckedCast (aObject.getClass ());
      final ISerializationConverter  aConverter = SerializationConverterRegistry.getInstance ().getConverter (aSrcClass);
      if (aConverter == null)
        throw new TypeConverterException (aSrcClass, EReason.NO_CONVERTER_FOUND_SINGLE);

      // Perform conversion
      aConverter.writeConvertedObject (aObject, aOOS);
    }
  }

  @Nullable
  public static  DSTTYPE readConvertedObject (@Nonnull final ObjectInputStream aOIS,
                                                       @Nonnull final Class  aDstClass) throws IOException
  {
    ValueEnforcer.notNull (aOIS, "ObjectInputStream");
    ValueEnforcer.notNull (aDstClass, "DestinationClass");

    // Was the object null?
    final boolean bIsNull = aOIS.readBoolean ();
    if (bIsNull)
    {
      // Don't read anything
      return null;
    }

    // Lookup converter
    final ISerializationConverter  aConverter = SerializationConverterRegistry.getInstance ().getConverter (aDstClass);
    if (aConverter == null)
      throw new TypeConverterException (aDstClass, EReason.NO_CONVERTER_FOUND_SINGLE);

    // Convert
    return GenericReflection.uncheckedCast (aConverter.readConvertedObject (aOIS));
  }
}