/*
 * Copyright (c) 2011-2017 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 * which is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 */

package io.vertx.core.shareddata;

An interface which allows you to put arbitrary objects into a LocalMap.

Normally local maps only allow immutable or copiable objects in order to avoid shared access to mutable state.

However if you have an object that you know is thread-safe you can mark it with this interface and then you will be able to add it to LocalMap instances.

Mutable object that you want to store in a LocalMap should override copy() method.

Use this interface with caution.

Author:Tim Fox
/** * An interface which allows you to put arbitrary objects into a {@link io.vertx.core.shareddata.LocalMap}. * <p> * Normally local maps only allow immutable or copiable objects in order to avoid shared access to mutable state. * <p> * However if you have an object that you know is thread-safe you can mark it with this interface and then you * will be able to add it to {@link io.vertx.core.shareddata.LocalMap} instances. * <p> * Mutable object that you want to store in a {@link io.vertx.core.shareddata.LocalMap} * should override {@link Shareable#copy()} method. * <p> * Use this interface with caution. * <p> * * @author <a href="http://tfox.org">Tim Fox</a> */
public interface Shareable {
Returns a copy of the object. Only mutable objects should provide a custom implementation of the method.
/** * Returns a copy of the object. * Only mutable objects should provide a custom implementation of the method. */
default Shareable copy() { return this; } }