org.gridgain.grid.marshaller.optimized.GridOptimizedMarshallable Maven / Gradle / Ivy

Go to download
/* 
 Copyright (C) GridGain Systems. All Rights Reserved.
 
 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.gridgain.grid.marshaller.optimized;

import java.util.*;

/**
 * Optional interface which helps make serialization even faster by removing internal
 * look-ups for classes.
 * 
 * All implementation must have the following:
 * 

 * 
 *     Must have static filed (private or public) declared of type {@link Object}
 *     with name {@code GG_CLASS_ID}. GridGain will reflectively initialize this field with
 *     proper class ID during system startup.
 * 
 * 
 *     Must return the value of {@code GG_CLASS_ID} field from {@link #ggClassId} method.
 * 
 * 
 * Here is a sample implementation:
 *  * // For better performance consider implementing java.io.Externalizable interface.
 * class ExampleMarshallable implements GridOptimizedMarshallable, Serializable {
 *     // Class ID field required by 'GridOptimizedMarshallable'.
 *     private static Object GG_CLASS_ID;
 *
 *     ...
 *
 *     @ public Object ggClassId() {
 *         return GG_CLASS_ID;
 *     }
 * }
 * 
 * 
 * Note that for better performance you should also specify list of classes you
 * plan to serialize via {@link GridOptimizedMarshaller#setClassNames(List)} method.
 */
public interface GridOptimizedMarshallable {
    /** */
    public static final String CLS_ID_FIELD_NAME = "GG_CLASS_ID";

    /**
     * Implementation of this method should simply return value of {@code GG_CLASS_ID} field.
     *
     * @return Class ID for optimized marshalling.
     */
    public Object ggClassId();
}