uk.ac.sussex.gdsc.smlm.results.ImmutablePeakResultStore Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gdsc-smlm Show documentation
Genome Damage and Stability Centre SMLM Package Software for single molecule localisation microscopy (SMLM)
The newest version!
/*-
 * #%L
 * Genome Damage and Stability Centre SMLM Package
 *
 * Software for single molecule localisation microscopy (SMLM)
 * %%
 * Copyright (C) 2011 - 2023 Alex Herbert
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

package uk.ac.sussex.gdsc.smlm.results;

import java.util.Collection;
import java.util.Objects;
import java.util.function.Predicate;
import uk.ac.sussex.gdsc.smlm.results.procedures.PeakResultProcedure;

/**
 * Stores peak results and prevents modification.
 */
public class ImmutablePeakResultStore implements PeakResultStore {
  private static final String IMMUTABLE_MESSAGE = "This results store is immutable";

  private final PeakResultStore store;

  /**
   * Instantiates a new immutable peak result store.
   *
   * @param store the store
   */
  public ImmutablePeakResultStore(PeakResultStore store) {
    this.store = Objects.requireNonNull(store, "store");
  }

  @Override
  public int size() {
    return store.size();
  }

  @Override
  public boolean add(PeakResult result) {
    throw new UnsupportedOperationException(IMMUTABLE_MESSAGE);
  }

  @Override
  public boolean addCollection(Collection results) {
    throw new UnsupportedOperationException(IMMUTABLE_MESSAGE);
  }

  @Override
  public boolean addArray(PeakResult[] results) {
    throw new UnsupportedOperationException(IMMUTABLE_MESSAGE);
  }

  @Override
  public boolean addStore(PeakResultStore results) {
    throw new UnsupportedOperationException(IMMUTABLE_MESSAGE);
  }

  @Override
  public boolean remove(PeakResult result) {
    throw new UnsupportedOperationException(IMMUTABLE_MESSAGE);
  }

  @Override
  public boolean removeCollection(Collection results) {
    throw new UnsupportedOperationException(IMMUTABLE_MESSAGE);
  }

  @Override
  public boolean removeArray(PeakResult[] results) {
    throw new UnsupportedOperationException(IMMUTABLE_MESSAGE);
  }

  @Override
  public boolean removeStore(PeakResultStore results) {
    throw new UnsupportedOperationException(IMMUTABLE_MESSAGE);
  }

  @Override
  public boolean retainCollection(Collection results) {
    throw new UnsupportedOperationException(IMMUTABLE_MESSAGE);
  }

  @Override
  public boolean retainArray(PeakResult[] results) {
    throw new UnsupportedOperationException(IMMUTABLE_MESSAGE);
  }

  @Override
  public boolean retainStore(PeakResultStore results) {
    throw new UnsupportedOperationException(IMMUTABLE_MESSAGE);
  }

  @Override
  public void clear() {
    throw new UnsupportedOperationException(IMMUTABLE_MESSAGE);
  }

  @Override
  public void trimToSize() {
    store.trimToSize();
  }

  @Override
  public PeakResult[] toArray() {
    return makeImmutable(store.toArray());
  }

  /**
   * Make the array a collection of immutable peak result objects.
   *
   * @param array the array
   * @return the array
   */
  private static PeakResult[] makeImmutable(PeakResult[] array) {
    for (int i = 0; i < array.length; i++) {
      array[i] = new ImmutablePeakResult(array[i]);
    }
    return array;
  }

  @Override
  public PeakResultStore copy() {
    return new ImmutablePeakResultStore(store.copy());
  }

  @Override
  public PeakResultStore copy(boolean deepCopy) {
    return new ImmutablePeakResultStore(store.copy(deepCopy));
  }

  @Override
  public boolean removeIf(Predicate filter) {
    throw new UnsupportedOperationException(IMMUTABLE_MESSAGE);
  }

  /**
   * Used to wrap the results to make them immutable.
   */
  private static class ImmutablePeakResultProcedure implements PeakResultProcedure {
    PeakResultProcedure procedure;

    ImmutablePeakResultProcedure(PeakResultProcedure procedure) {
      this.procedure = procedure;
    }

    @Override
    public void execute(PeakResult peakResult) {
      procedure.execute(new ImmutablePeakResult(peakResult));
    }
  }

  @Override
  public void forEach(PeakResultProcedure procedure) {
    store.forEach(new ImmutablePeakResultProcedure(procedure));
  }

  @Override
  public PeakResult[] subset(Predicate filter) {
    return makeImmutable(store.subset(filter));
  }

  @Override
  public boolean contains(PeakResult result) {
    return store.contains(result);
  }
}