Phase.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2022 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.phase;
 
import java.util.Date;
import java.util.SortedSet;
import java.util.TreeSet;
 
public abstract class Phase {
 
  protected PhaseDefinition current;
  protected boolean autoChanging = false, changed = false;
 
  public Phase(PhaseDefinition current) {
    this.current = current;
  }
 
  public PhaseDefinition getCurrent() {
    return current;
  }
 
  public boolean isAutoChanging() {
    return autoChanging;
  }
 
  public boolean isChanged() {
    return changed;
  }
  
  public synchronized void checkStatus(Date now) {
    PhaseDefinition newPhase = doCheckPhase(now);
    if(current == null || (!newPhase.equals(current) && canChangeTo(newPhase))) {
      autoChanging = true;
      try {
        onChanging(newPhase);
        newPhase = doChangeTo(newPhase);
        onChanged(newPhase);
        current = newPhase;
      } finally {
        autoChanging = false;
      }
    }
  }
  
  public synchronized void changeTo(PhaseDefinition newPhase) {
    PhaseDefinition tmp = current;
    onChanging(newPhase);
    current = doChangeTo(newPhase);
    changed = !current.equals(tmp);
    onChanged(current);
  }
  
  protected abstract PhaseDefinition doCheckPhase(Date now);
  protected abstract PhaseDefinition doChangeTo(PhaseDefinition newPhase);
    
  public boolean canChangeTo(PhaseDefinition newPhase) {
    return !current.equals(newPhase);
  }
  
  public String getName() {
    return current.toString();
  }
  
  protected void onChanging(PhaseDefinition newStatus) {}
  protected void onChanged(PhaseDefinition newStatus) {}
  
  protected SortedSet<PhaseDefinition> allPhases() {
    return PhaseDefinitions.instance();
  }
 
  public SortedSet<PhaseDefinition> getPossiblePhases() {
    SortedSet<PhaseDefinition> possible = new TreeSet<>();
    for(PhaseDefinition phase : allPhases()) {
      if(canChangeTo(phase)) {
        possible.add(phase);
      }
    }
    return possible;
  }
  
}