/**
 * This file is part of the Meeds project (https://meeds.io/).
 *
 * Copyright (C) 2020 - 2025 Meeds Association contact@meeds.io
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package org.gatein.pc.api;

import org.gatein.common.util.ParameterValidation;

/**
 * An event that signals state modifications
 *
 */
public class StateEvent
{

   /** . */
   private final PortletContext context;

   /** . */
   private final Type type;

   public StateEvent(PortletContext context, Type type)
   {
      ParameterValidation.throwIllegalArgExceptionIfNull(context, "Portlet context");
      ParameterValidation.throwIllegalArgExceptionIfNull(type, "StateEvent type");

      //
      this.context = context;
      this.type = type;
   }

   public PortletContext getPortletContext()
   {
      return context;
   }

   public Type getType()
   {
      return type;
   }

   public enum Type
   {

      PORTLET_CLONED_EVENT("Portlet Cloned Event"), PORTLET_MODIFIED_EVENT("Portlet Modified Event");

      /** . */
      private final String description;

      private Type(String description)
      {
         this.description = description;
      }

      public String toString()
      {
         return description;
      }
   }
}
