/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.ignite.internal.network.serialization.marshal;

import org.jetbrains.annotations.Nullable;

/**
 * Marshals/unmarshals objects in accordance with User Object Serialization.
 *
 * @see <a href="https://cwiki.apache.org/confluence/display/IGNITE/IEP-67%3A+Networking+module">IEP-67</a>
 */
public interface UserObjectMarshaller {
    /**
     * Marshals an object detecting its type from the value.
     *
     * @param object        object to marshal
     * @return marshalled representation
     * @throws MarshalException if marshalling fails
     */
    MarshalledObject marshal(@Nullable Object object) throws MarshalException;

    /**
     * Unmarshals an object.
     *
     * @param bytes             bytes representing the marshalled object
     * @param mergedDescriptors the remote descriptors that need to be used for unmarshalling plus our local descriptors
     *                          (remote ones have the priority)
     * @param <T> expected type
     * @return unmarshalled object
     * @throws UnmarshalException if unmarshalling fails
     */
    @Nullable
    <T> T unmarshal(byte[] bytes, Object mergedDescriptors) throws UnmarshalException;
}
