com.arangodb.shaded.vertx.core.shareddata.Shareable Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2019 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 com.arangodb.shaded.vertx.core.shareddata;
/**
* An interface which allows you to put arbitrary objects into a {@link com.arangodb.shaded.vertx.core.shareddata.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 {@link com.arangodb.shaded.vertx.core.shareddata.LocalMap} instances.
*
* Mutable object that you want to store in a {@link com.arangodb.shaded.vertx.core.shareddata.LocalMap}
* should override {@link Shareable#copy()} method.
*
* Use this interface with caution.
*
*
* @author Tim Fox
*/
public interface Shareable {
/**
* Returns a copy of the object.
* Only mutable objects should provide a custom implementation of the method.
*/
default Shareable copy() {
return this;
}
}