com.alachisoft.ncache.serialization.standard.io.surrogates.ByteArraySerializationSurrogate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nc-serialization Show documentation
Internal package of Alachisoft.
There is a newer version: 5.3.3
/*
 * @(#)ByteArraySerializationSurrogate.java	1.0
 *
 * Created on September 18, 2008, 12:59 PM
 *
 * Copyright 2008 NeXtreme Innovations, Inc. All rights reserved.
 * "NeXtreme Innovations" PROPRIETARY/CONFIDENTIAL. Use is subject
 * to license terms.
 */
package com.alachisoft.ncache.serialization.standard.io.surrogates;

import com.alachisoft.ncache.serialization.core.io.NCacheObjectInput;
import com.alachisoft.ncache.serialization.core.io.NCacheObjectOutput;
import com.alachisoft.ncache.serialization.core.io.surrogates.BuiltinSerializationSurrogate;
import com.alachisoft.ncache.serialization.core.io.surrogates.NCacheIOException;
import com.alachisoft.ncache.serialization.core.io.surrogates.NCacheInstantiationException;
import com.alachisoft.ncache.serialization.core.io.surrogates.SerializationSurrogateImpl;

import java.io.IOException;

/**
 * ByteArraySerializationSurrogate is responsible for writing and reading
 * instances of byte[] class.
 *
 * @version 1.0, September 18, 2008
 */
public class ByteArraySerializationSurrogate
        extends SerializationSurrogateImpl
        implements BuiltinSerializationSurrogate {

    /**
     * Creates a new instance of NxObjectArraySerializationSurrogate
     */
    public ByteArraySerializationSurrogate() {
        super(byte[].class);
    }

    /**
     * Creates instance of type returned by getRealClass(). This is different from NxSerializationSurrogateBase.createTypeInstance()
     * in the sense that an NCacheObjectInput object is passed as parameter that can be used to read creation specific
     * information from the stream. For example it can be used to read the length of the array before actually
     * reading the values.
     * 
     * The default implementation simply delegates to super.createTypeInstance().
     *
     * @param input stream reader
     * @return Object that this surrogate must deserialize
     * @throws NCacheInstantiationException Object creation related exceptions.
     */
    @Override
    public Object instantiate(NCacheObjectInput input)
            throws NCacheInstantiationException {
        try {
            int length = input.readInt();
            return new byte[length];
        } catch (IOException ex) {
            throw new NCacheInstantiationException(ex);
        }
    }

    /**
     * Read an object of type returned by getRealClass() from the stream reader.
     * A fresh instance of the object is passed as parameter.
     * The surrogate should populate fields in the object from data on the stream
     *
     * @param input stream reader
     * @param graph a fresh instance of the object that the surrogate must deserialize.
     * @return object read from the stream reader
     * @throws NCacheInstantiationException Object creation related exceptions.
     * @throws NCacheIOException            Any of the usual Input/Output related exceptions.
     */
    public Object readDirect(NCacheObjectInput input, Object graph)
            throws NCacheInstantiationException, NCacheIOException {
        try {
            byte[] array = (byte[]) graph;
            input.readFully(array);
            return array;
        } catch (IOException ex) {
            throw new NCacheIOException(ex);
        }
    }

    /**
     * Write an object of type returned by getRealClass() to the stream writer
     *
     * @param output stream writer
     * @param graph  object to be written to the stream reader
     * @throws NCacheIOException Any of the usual Input/Output related exceptions.
     */
    public void writeDirect(NCacheObjectOutput output, Object graph)
            throws NCacheIOException {
        try {
            byte[] array = (byte[]) graph;
            output.writeInt(array.length);
            output.write(array);
        } catch (IOException ex) {
            throw new NCacheIOException(ex);
        }
    }

    @Override
    public void skipDirect(NCacheObjectInput input, Object graph) throws NCacheInstantiationException, NCacheIOException {
        try {
            byte[] array = (byte[]) graph;
            input.skipBytes(array.length);
        } catch (IOException ex) {
            throw new NCacheIOException(ex);
        }
    }
}