Remove pointless interface combinations and Javadoc clean-up

This commit is contained in:
leventov
2015-08-08 19:09:08 +03:00
parent 9ffa4a3f25
commit 51140ef343
12 changed files with 35 additions and 64 deletions
@@ -21,7 +21,7 @@ import net.openhft.chronicle.set.SetEntry;
import org.jetbrains.annotations.NotNull;
/**
* The <i>present</i> {@code ChronicleHash} entry context.
* A context of a <i>present</i> entry in the {@code ChronicleHash}.
*
* <p>This interface is not usable by itself; it merely defines the common base for {@link MapEntry}
* and {@link SetEntry}.
@@ -1,24 +0,0 @@
/*
* Copyright (C) 2015 higherfrequencytrading.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package net.openhft.chronicle.hash.replication;
import net.openhft.chronicle.hash.HashQueryContext;
public interface HashRemoteQueryContext<K> extends HashQueryContext<K>, RemoteOperationContext<K> {
@Override
HashReplicableEntry<K> entry();
}
@@ -1,23 +0,0 @@
/*
* Copyright (C) 2015 higherfrequencytrading.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package net.openhft.chronicle.hash.replication;
import net.openhft.chronicle.hash.HashEntry;
public interface HashReplicableEntry<K> extends HashEntry<K>, ReplicableEntry {
}
@@ -21,13 +21,14 @@ import net.openhft.chronicle.hash.ChronicleHashBuilder;
import net.openhft.chronicle.hash.HashAbsentEntry;
import net.openhft.chronicle.hash.HashEntry;
import net.openhft.chronicle.map.ChronicleMap;
import net.openhft.chronicle.map.MapEntry;
import net.openhft.chronicle.map.Replica;
import net.openhft.chronicle.map.replication.MapRemoteOperations;
import net.openhft.chronicle.set.replication.SetRemoteOperations;
/**
* Abstracts an in replicated {@link ChronicleHash}. A {@link HashAbsentEntry} might be a {@code
* ReplicableEntry} as well as {@link HashEntry}.
* Abstracts a replicable entry in the replicated {@link ChronicleHash}. A {@link HashAbsentEntry}
* might be a {@code ReplicableEntry} as well as {@link HashEntry}.
*/
public interface ReplicableEntry {
/**
@@ -35,7 +36,7 @@ public interface ReplicableEntry {
* the identifier of the {@code ChronicleHash} node on which this entry was updated last.
*
* <p>When the entry is replicated, this identifier comes to remote nodes as {@link
* HashRemoteQueryContext#remoteIdentifier()}.
* RemoteOperationContext#remoteIdentifier()}.
*
* <p>On {@code ChronicleHash} local operations with entries, like {@link ChronicleMap#put(
* Object, Object)}, this identifier is overwritten to the own {@code ChronicleHash} {@link
@@ -52,7 +53,7 @@ public interface ReplicableEntry {
* the time of the last.
*
* <p>When the entry is replicated, this timestamp comes to remote nodes as {@link
* HashRemoteQueryContext#remoteTimestamp()}.
* RemoteOperationContext#remoteTimestamp()}.
*
* <p>On {@code ChronicleHash} local operations with entries, like {@link ChronicleMap#put(
* Object, Object)}, this timestamp is overwritten using {@linkplain
@@ -21,7 +21,7 @@ import net.openhft.chronicle.hash.HashEntry;
import org.jetbrains.annotations.NotNull;
/**
* The <i>present</i> {@code ChronicleHash} entry context.
* A context of a <i>present</i> entry in the {@code ChronicleHash}.
*
* @param <K> the map key type
* @param <V> the map value type
@@ -21,7 +21,7 @@ import net.openhft.chronicle.map.replication.MapRemoteOperations;
import org.jetbrains.annotations.Nullable;
/**
* The context of {@link ChronicleMap} operations with <i>individual keys</i>
* A context of {@link ChronicleMap} operations with <i>individual keys</i>
* (like during {@code get()}, {@code put()}, etc., opposed to <i>bulk</i> operations).
* This is the main context type of {@link MapMethods} and {@link MapRemoteOperations}.
*
@@ -17,7 +17,7 @@
package net.openhft.chronicle.map.replication;
import net.openhft.chronicle.hash.Data;
import net.openhft.chronicle.hash.replication.HashRemoteQueryContext;
import net.openhft.chronicle.hash.replication.RemoteOperationContext;
import net.openhft.chronicle.hash.serialization.SizeMarshaller;
import net.openhft.chronicle.map.ChronicleMap;
import net.openhft.chronicle.map.ChronicleMapBuilder;
@@ -34,7 +34,7 @@ import org.jetbrains.annotations.Nullable;
* @see MapRemoteOperations
*/
public interface MapRemoteQueryContext<K, V, R> extends MapQueryContext<K, V, R>,
HashRemoteQueryContext<K> {
RemoteOperationContext<K> {
@Nullable
@Override
MapReplicableEntry<K, V> entry();
@@ -16,8 +16,17 @@
package net.openhft.chronicle.map.replication;
import net.openhft.chronicle.hash.replication.HashReplicableEntry;
import net.openhft.chronicle.hash.replication.ReplicableEntry;
import net.openhft.chronicle.map.ChronicleMap;
import net.openhft.chronicle.map.MapEntry;
public interface MapReplicableEntry<K, V> extends MapEntry<K, V>, HashReplicableEntry<K> {
/**
* A context of a <i>present</i> entry in the replicated {@link ChronicleMap}.
*
* @param <K> the map key type
* @param <V> the map value type
* @see MapRemoteOperations
* @see MapRemoteQueryContext
*/
public interface MapReplicableEntry<K, V> extends MapEntry<K, V>, ReplicableEntry {
}
@@ -19,7 +19,7 @@ package net.openhft.chronicle.set;
import net.openhft.chronicle.hash.HashEntry;
/**
* The <i>present</i> {@link ChronicleSet} entry context.
* A context of a <i>present</i> entry in the {@link ChronicleSet}.
*
* @param <K> the set key type
* @see SetEntryOperations
@@ -25,7 +25,7 @@ import net.openhft.chronicle.set.replication.SetRemoteOperations;
import org.jetbrains.annotations.Nullable;
/**
* The context of {@link ChronicleSet} operations with <i>individual keys</i>
* A context of {@link ChronicleSet} operations with <i>individual keys</i>
* (most: {@code contains()}, {@code add()}, etc., opposed to <i>bulk</i> operations).
*
* @param <K> the set key type
@@ -16,7 +16,7 @@
package net.openhft.chronicle.set.replication;
import net.openhft.chronicle.hash.replication.HashRemoteQueryContext;
import net.openhft.chronicle.hash.replication.RemoteOperationContext;
import net.openhft.chronicle.set.ChronicleSet;
import net.openhft.chronicle.set.SetEntryOperations;
import net.openhft.chronicle.set.SetQueryContext;
@@ -30,7 +30,7 @@ import org.jetbrains.annotations.Nullable;
* @see SetRemoteOperations
*/
public interface SetRemoteQueryContext<K, R>
extends SetQueryContext<K, R>, HashRemoteQueryContext<K> {
extends SetQueryContext<K, R>, RemoteOperationContext<K> {
@Override
@Nullable
SetReplicableEntry<K> entry();
@@ -16,8 +16,16 @@
package net.openhft.chronicle.set.replication;
import net.openhft.chronicle.hash.replication.HashReplicableEntry;
import net.openhft.chronicle.hash.replication.ReplicableEntry;
import net.openhft.chronicle.set.ChronicleSet;
import net.openhft.chronicle.set.SetEntry;
public interface SetReplicableEntry<K> extends SetEntry<K>, HashReplicableEntry<K> {
/**
* A context of a <i>present</i> entry in the replicated {@link ChronicleSet}.
*
* @param <K> the set key type
* @see SetRemoteOperations
* @see SetRemoteQueryContext
*/
public interface SetReplicableEntry<K> extends SetEntry<K>, ReplicableEntry {
}