org.jppf.client.event.ClientQueueEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jppf-client Show documentation

JPPF, the open source grid computing solution

There is a newer version: 6.3-alpha

/*
 * JPPF.
 * Copyright (C) 2005-2015 JPPF Team.
 * http://www.jppf.org
 *
 * 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 org.jppf.client.event;

import java.util.*;

import org.jppf.client.*;
import org.jppf.client.balancer.queue.JPPFPriorityQueue;

/**
 * Instances of this class represent events emitted by the JPPF client job queue whenever a job is added to or removed from the queue.
 * @author Laurent Cohen
 * @since 4.1
 */
public class ClientQueueEvent extends EventObject {
  /**
   * The job this event is for.
   */
  private final JPPFJob job;
  /**
   * The job queue from which this event originates.
   */
  private final JPPFPriorityQueue queue;

  /**
   * Initialize this event with the specified source JPPF client and Job.
   * @param client the client whose queue emitted the event.
   * @param job the job this event is for.
   * @param queue the job queue which emitted this event.
   */
  public ClientQueueEvent(final JPPFClient client, final JPPFJob job, final JPPFPriorityQueue queue) {
    super(client);
    this.job = job;
    this.queue = queue;
  }

  /**
   * Get the JPPF client source of this event.
   * @return a {@link JPPFClient} instance.
   */
  public JPPFClient getClient() {
    return (JPPFClient) getSource();
  }

  /**
   * Get the job that was added or removed.
   * @return a {@link JPPFJob} instance.
   */
  public JPPFJob getJob() {
    return job;
  }

  /**
   * Get all the {@link JPPFJob}s currently in the queue.
   * This method should be used with caution, as its cost is in O(n), with n being the number of jobs in the queue.
   * @return a list of {@link JPPFJob} instances ordered by their priority.
   */
  public List getQueuedJobs() {
    return queue.getJPPFJobs();
  }

  /**
   * Get the size of this job queue.
   * This method should be used with caution, as its cost is in O(n), with n being the number of jobs in the queue.
   * @return the number of jobs currently in the queue.
   */
  public int getQueueSize() {
    return queue.getQueueSize();
  }
}