/*
 * MIT License
 *
 * Copyright (c) 2016 Andrew Michael Teller(https://github.com/AndrewMiTe)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package battle;

import java.time.Duration;
import java.time.LocalDateTime;

/**
 * A point in time within a turn order can be called in order to perform an
 * action.
 * @author Andrew M. Teller(https://github.com/AndrewMiTe)
 */
public interface TurnItem {

  /**
   * Returns the time when the turn item will be due.
   * @param currentTime the current time.
   * @return time of the turn.
   */
  public LocalDateTime getTurnTime(LocalDateTime currentTime);
  
  /**
   * Advances the time dependent values of the turn item.
   * @param timeChange 
   */
  public void advanceTime(Duration timeChange);
  
  /**
   * Returns the actor responsible for the turn item so that it can mark the
   * turn for removal when that actor leaves battle.
   * @return the actor of the turn. 
   */
  public Actor getActor();
}

/*
 * MIT License
 *
 * Copyright (c) 2016 Andrew Michael Teller(https://github.com/AndrewMiTe)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package battle;

import java.time.Duration;
import java.time.LocalDateTime;

/**
 * A point in time within a turn order can be called in order to perform an
 * action.
 * @author Andrew M. Teller(https://github.com/AndrewMiTe)
 */
public interface TurnItem {

  /**
   * Returns the time when the turn item will be due.
   * @param currentTime the current time.
   * @return time of the turn.
   */
  public LocalDateTime getTurnTime(LocalDateTime currentTime);
  
  /**
   * Advances the time dependent values of the turn item.
   * @param timeChange 
   * @return {@code true} if the advancement ended in a successful event.  
   */
  public boolean advanceTime(Duration timeChange);
  
  /**
   * Returns the actor responsible for the turn item so that it can mark the
   * turn for removal when that actor leaves battle.
   * @return the actor of the turn. 
   */
  public Actor getActor();
  
}

Return type for advanceTime changed to boolean.