CatchAllEvent.java

/*
 jBilling - The Enterprise Open Source Billing System
 Copyright (C) 2003-2011 Enterprise jBilling Software Ltd. and Emiliano Conde

 This file is part of jbilling.

 jbilling 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.

 jbilling 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 jbilling.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.sapienter.jbilling.server.system.event;

/**
 * Marker event that can be used as an IInternalEventTask subscription
 * to denote a subscription to any and all internal events.
 * 
 * <code>
 *   // IInternalEventTaskImpl:
 *   public Class<Event>[] getSubscribedEvents() {
 *       return new Class[] { CatchAllEvent.class };
 *   }
 * </code>
 *
 * This event class cannot be instantiated!
 *
 * @author Brian Cowdery
 * @since 07-04-2010
 */
public class CatchAllEvent implements Event {

    private CatchAllEvent() {
        // cannot be instantiated!
    }

    public String getName() {
        return "any/all events";
    }

    public Integer getEntityId() {
        return null;
    }
}