Open Source Repository

Home /spring/spring-core-3.0.5 | Repository Home



org/springframework/core/serializer/support/SerializingConverter.java
/*
 * Copyright 2002-2010 the original author or authors.
 *
 * 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.springframework.core.serializer.support;

import java.io.ByteArrayOutputStream;

import org.springframework.core.convert.converter.Converter;
import org.springframework.core.serializer.DefaultSerializer;
import org.springframework.core.serializer.Serializer;
import org.springframework.util.Assert;

/**
 * A {@Link Converter} that delegates to a {@link org.springframework.core.serializer.Serializer}
 * to convert an object to a byte array.
 *
 @author Gary Russell
 @author Mark Fisher
 @since 3.0.5
 */
public class SerializingConverter implements Converter<Object, byte[]{

  private final Serializer<Object> serializer;


  /**
   * Create a default SerializingConverter that uses standard Java serialization.
   */
  public SerializingConverter() {
    this.serializer = new DefaultSerializer();
  }

  /**
   * Create a SerializingConverter that delegates to the provided {@link Serializer}
   */
  public SerializingConverter(Serializer<Object> serializer) {
    Assert.notNull(serializer, "Serializer must not be null");
    this.serializer = serializer;
  }


  /**
   * Serializes the source object and returns the byte array result.
   */
  public byte[] convert(Object source) {
    ByteArrayOutputStream byteStream = new ByteArrayOutputStream(128);
    try  {
      this.serializer.serialize(source, byteStream);
      return byteStream.toByteArray();
    }
    catch (Throwable ex) {
      throw new SerializationFailedException("Failed to serialize object using " +
          this.serializer.getClass().getSimpleName(), ex);
    }
  }

}