code: /*
   * Copyright 2012-2018 Chronicle Map Contributors
   *
   * 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 net.openhft.chronicle.map.impl.stage.iter;
  
  import net.openhft.chronicle.hash.Data;
  import net.openhft.chronicle.hash.ReplicatedHashSegmentContext;
  import net.openhft.chronicle.hash.replication.ReplicableEntry;
  import net.openhft.chronicle.map.MapEntry;
  import net.openhft.chronicle.map.impl.ReplicatedIterationContext;
  import net.openhft.chronicle.map.impl.VanillaChronicleMapHolder;
  import net.openhft.chronicle.map.impl.stage.data.DummyValueZeroData;
  import net.openhft.chronicle.map.impl.stage.entry.ReplicatedMapEntryStages;
  import net.openhft.chronicle.map.impl.stage.replication.ReplicationUpdate;
  import net.openhft.chronicle.set.DummyValueData;
  import net.openhft.sg.StageRef;
  import net.openhft.sg.Staged;
  
  import java.util.function.Consumer;
  import java.util.function.Predicate;
  
  import static net.openhft.chronicle.map.impl.stage.iter.ReplicatedMapSegmentIteration.EntriesToTest.ALL;
  import static net.openhft.chronicle.map.impl.stage.iter.ReplicatedMapSegmentIteration.EntriesToTest.PRESENT;
  
  @Staged
  public abstract class ReplicatedMapSegmentIteration<K, V, R> extends MapSegmentIteration<K, V, R>
          implements ReplicatedIterationContext<K, V, R>, ReplicableEntry,
          ReplicatedHashSegmentContext<K, MapEntry<K, V>> {
  
      @StageRef
      VanillaChronicleMapHolder<K, V, R> mh;
      @StageRef
      ReplicatedMapEntryStages<K, V> e;
      @StageRef
      ReplicationUpdate<K> ru;
      @StageRef
      DummyValueZeroData<V> dummyValue;
      @StageRef
      ReplicatedMapAbsentDelegatingForIteration<K, V> absentEntryDelegating;
      @StageRef
      ReplicatedMapEntryDelegating<K, V> entryDelegating;
      EntriesToTest entriesToTest = null;
  
      void initEntriesToTest(EntriesToTest entriesToTest) {
          this.entriesToTest = entriesToTest;
      }
  
      @Override
      public boolean shouldTestEntry() {
          throwExceptionIfClosed();
  
          return entriesToTest == ALL || !e.entryDeleted();
      }
  
      @Override
      public Object entryForIteration() {
          throwExceptionIfClosed();
  
          return !e.entryDeleted() ? entryDelegating : absentEntryDelegating;
      }
  
      @Override
      public long tierEntriesForIteration() {
          throwExceptionIfClosed();
  
          return entriesToTest == ALL ? s.tierEntries() : s.tierEntries() - s.tierDeleted();
      }
  
      @Override
      public void doReplaceValue(Data<V> newValue) {
          throwExceptionIfClosed();
  
          checkOnEachPublicOperation.checkOnEachPublicOperation();
          try {
              entry.innerDefaultReplaceValue(newValue);
              e.updatedReplicationStateOnPresentEntry();
              ru.updateChange();
          } finally {
              s.innerWriteLock.unlock();
          }
      }
  
      @Override
      public boolean forEachSegmentEntryWhile(Predicate<? super MapEntry<K, V>> predicate) {
          throwExceptionIfClosed();
  
          checkOnEachPublicOperation.checkOnEachPublicOperation();
          initEntriesToTest(PRESENT);
          s.innerUpdateLock.lock();
          return innerForEachSegmentEntryWhile(predicate);
      }
  
      @Override
      public boolean forEachSegmentReplicableEntryWhile(
              Predicate<? super ReplicableEntry> predicate) {
          throwExceptionIfClosed();
  
          checkOnEachPublicOperation.checkOnEachPublicOperation();
          initEntriesToTest(ALL);
          s.innerUpdateLock.lock();
          return innerForEachSegmentEntryWhile(predicate);
      }
  
      @Override
      public void forEachSegmentReplicableEntry(Consumer<? super ReplicableEntry> action) {
          throwExceptionIfClosed();
  
          forEachSegmentReplicableEntryWhile(e -> {
              action.accept(e);
              return true;
          });
      }
  
      @Override
      public void doRemove() {
          throwExceptionIfClosed();
  
          checkOnEachPublicOperation.checkOnEachPublicOperation();
          try {
              if (e.valueSize > dummyValue.size())
                  e.innerDefaultReplaceValue(dummyValue);
              e.updatedReplicationStateOnPresentEntry();
              e.writeEntryDeleted();
              ru.updateChange();
              s.tierDeleted(s.tierDeleted() + 1);
          } finally {
              s.innerWriteLock.unlock();
          }
          initEntryRemovedOnThisIteration(true);
      }
  
      @Override
      public void doRemoveCompletely() {
          throwExceptionIfClosed();
  
          boolean wasDeleted = e.entryDeleted();
          super.doRemove();
          ru.dropChange();
          if (wasDeleted)
              s.tierDeleted(s.tierDeleted() - 1);
      }
  
      public void doInsert(Data<V> value) {
          throwExceptionIfClosed();
  
          checkOnEachPublicOperation.checkOnEachPublicOperation();
          if (e.entryDeleted()) {
              try {
                  s.tierDeleted(s.tierDeleted() - 1);
                  e.innerDefaultReplaceValue(value);
                  s.incrementModCount();
                  e.writeEntryPresent();
                  e.updatedReplicationStateOnPresentEntry();
                  ru.updateChange();
              } finally {
                  s.innerWriteLock.unlock();
              }
          } else {
              throw new IllegalStateException(mh.h().toIdentityString() +
                      ": Entry is present in the map when doInsert() is called");
          }
      }
  
      public void doInsert() {
          throwExceptionIfClosed();
  
          if (mh.set() == null)
              throw new IllegalStateException(mh.h().toIdentityString() +
                      ": Called SetAbsentEntry.doInsert() from Map context");
          doInsert((Data<V>) DummyValueData.INSTANCE);
      }
  
      enum EntriesToTest {PRESENT, ALL}
  }
  