javax.enterprise.deploy.spi.status.ProgressEvent Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of javaee-api Show documentation
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2018 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.enterprise.deploy.spi.status;

import javax.enterprise.deploy.spi.TargetModuleID;
import java.util.EventObject;

/**
 * An event which indicates that a deployment
 * status change has occurred.
 *
 * @see ProgressListener 
 * @see ProgressObject
 */
public class ProgressEvent extends EventObject
{
   transient private DeploymentStatus statuscode; // TODO fully implement Serializable if this is needed.
   transient private TargetModuleID targetModuleID;

   /**
    * Creates a new object representing a deployment
    * progress event.
    *
    * @param source the object on which the Event initially occurred.
    * @param sCode  the object containing the status 
    *               information.
    */
   public ProgressEvent (Object source, TargetModuleID targetModuleID,
             DeploymentStatus sCode)
   {
      super(source);
      this.statuscode = sCode;
      this.targetModuleID = targetModuleID;
   }

   /**
    * Retrieve the TargetModuleID for this event
    *
    * @return the object containing the TargetModuleID
    */ 
   public TargetModuleID getTargetModuleID()
   {
     return targetModuleID;
   }

   /**
    * Retrieve the status information.
    *
    * @return the object containing the status information.
    */
   public DeploymentStatus getDeploymentStatus()
   {
      return statuscode;
   }
}