Android Open Source - AndroidTasks Base Timer Task

From Project

Back to project page AndroidTasks.

License

The source code is released under:

Apache License

If you think the Android project AndroidTasks listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.

Java Source Code

/*
 * Copyright (C) 2013 BeyondAR/*from ww w.j a va 2  s.c o  m*/
 *
 * 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 com.beyondar.android.util.task;

public abstract class BaseTimerTask extends BaseTask {

  private long lastExecution;
  private long timer;
  private boolean kill;
  private boolean runInBackGround;

  /**
   * @param id
   *            The id of this task
   * @param timer
   *            The the sleeping time between for this task in milliseconds
   */
  public BaseTimerTask(long id, long timer) {
    super(id);

    lastExecution = 0;
    this.timer = timer;
    runInBackGround = false;
  }

  /**
   * @param id
   *            The id of this task
   * @param timer
   *            The the sleeping time between for this task in milliseconds
   * @param runInBackground
   *            Set true if you want to execute this task if the app is
   *            running in background
   */
  public BaseTimerTask(long id, long timer, boolean runInBackground) {
    super(id);

    lastExecution = 0;
    this.timer = timer;
    this.runInBackGround = runInBackground;
  }

//  public int getTaskType() {
//    return TASK_TYPE_TIMER;
//  }

  /**
   * Get if this tasks can be executed in background
   * 
   * @return True if this task can run in background, false otherwise.
   */
  public boolean backGroundRunnable() {
    return runInBackGround;
  }

  public TaskResult executeTask() {
    TaskResult out = super.executeTask();
    if (!isWaitingUntilOtherTaskFinishes()) {
      lastExecution = System.currentTimeMillis();
    }
    return out;
  }

  /**
   * Get the sleeping time before execute
   * 
   * @return sleeping time in milliseconds
   */
  public long getTimer() {
    return timer;
  }

  /**
   * Get when was the last time that the task manager execute this task
   * 
   * @return last time in milliseconds
   */
  public final long getLastExecutionTime() {
    return lastExecution;
  }

  /**
   * Define if the task should not be executed anymore
   * 
   */
  public void killTask() {
    kill = true;
  }

  /**
   * Get if the task should be killed by the {@link TaskExecutor}
   * 
   * @return true to kill it, false otherwise
   */
  public boolean isKillable() {
    return kill;

  }

  public abstract TaskResult runTask();

}

Java Source Code List