com.hazelcast.spi.merge.MergingValue Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hazelcast-jdbc Show documentation
Hazelcast JDBC Driver
The newest version!
/*
 * Copyright (c) 2008-2024, Hazelcast, Inc. 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 com.hazelcast.spi.merge;

/**
 * Represents a read-only view of a data structure value for the merging process after a split-brain.
 *
 * @param  the type of the value
 * @since 3.10
 */
public interface MergingValue extends MergingView {

    /**
     * Returns the merging value in deserialized form.
     *
     * @implNote This method invokes deserialization of the value
     * when called - be careful not to use it internally
     * within a cluster as the member may not have information
     * available to deserialize correctly, resulting in an
     * {@code Exception} being raised.
     *
     * @return the deserialized merging value
     * @deprecated since 5.4 - this method name is too ambiguous and does
     * not convey its functionality well (it deserializes the value) - so
     * it is being replaced by {@link #getDeserializedValue()}.
     */
    @Deprecated
    default V getValue() {
        return getDeserializedValue();
    }

    /**
     * Returns the merging value in deserialized form.
     *
     * @implNote This method invokes deserialization of the value
     * when called - be careful not to use it internally
     * within a cluster as the member may not have information
     * available to deserialize correctly, resulting in an
     * {@code Exception} being raised.
     *
     * @return the deserialized merging value
     * @since 5.4
     */
    V getDeserializedValue();

    /**
     * Returns the merging value in the in-memory format of the backing data structure.
     *
     * @return the merging value
     */
    Object getRawValue();
}