Restart.java

/*
 * This file is part of Waarp Project (named also Waarp or GG).
 *
 *  Copyright (c) 2019, Waarp SAS, and individual contributors by the @author
 *  tags. See the COPYRIGHT.txt in the distribution for a full listing of
 * individual contributors.
 *
 *  All Waarp Project 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.
 *
 * Waarp 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
 * Waarp . If not, see <http://www.gnu.org/licenses/>.
 */
package org.waarp.common.file;

import org.waarp.common.command.exception.CommandAbstractException;
import org.waarp.common.exception.NoRestartException;

/**
 * Restart object that implements the REST command.<br>
 * Note that if necessary, according to the implementation of {@link
 * DirInterface} and {@link FileInterface},
 * one could want to implement a way to store or retrieve Marker from/to the
 * client specification.
 */
public abstract class Restart {
  /**
   * SessionInterface
   */
  private final SessionInterface session;

  /**
   * Is the current Restart object in context set
   */
  private boolean isSet;

  /**
   * Default constructor
   *
   * @param session
   */
  protected Restart(final SessionInterface session) {
    isSet = false;
    this.session = session;
  }

  /**
   * @return the isSet
   */
  protected final boolean isSet() {
    return isSet;
  }

  /**
   * @param isSet the isSet to set
   */
  public void setSet(final boolean isSet) {
    this.isSet = isSet;
  }

  /**
   * @return the session
   */
  protected final SessionInterface getSession() {
    return session;
  }

  /**
   * Restart from a Marker for the next FileInterface
   *
   * @param marker
   *
   * @return True if the Marker is OK
   *
   * @throws CommandAbstractException
   */
  public abstract boolean restartMarker(String marker)
      throws CommandAbstractException;

  /**
   * @return the position from a previous REST command
   *
   * @throws NoRestartException if no REST command was issued before
   */
  public abstract long getPosition() throws NoRestartException;

  // FIXME Additionally the implementation should implement a way to get the
  // values

  /**
   * @param nextBlock
   *
   * @return the max between the available size and the nextblock size
   */
  public abstract int getMaxSize(int nextBlock);
}