org.xwiki.job.event.AbstractJobEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-job Show documentation
XWiki Commons - Job
There is a newer version: 16.10.2
/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This 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 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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 software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.job.event;

import java.util.List;

import org.xwiki.job.Request;

/**
 * Common implementation for job events.
 *
 * @version $Id: a3b2ed2d1b0d0ca0c7e9e4b4dfd53d0e50bcaf09 $
 * @since 4.0M1
 */
abstract class AbstractJobEvent implements JobEvent
{
    /**
     * Serializable identifier.
     */
    private static final long serialVersionUID = 1L;

    /**
     * Related job request.
     */
    private Request request;

    /**
     * Related job id.
     */
    private List jobId;

    /**
     * Related job type.
     */
    private String jobType;

    /**
     * Default constructor.
     */
    AbstractJobEvent()
    {
    }

    /**
     * @param jobType the event related job type
     */
    protected AbstractJobEvent(String jobType)
    {
        this.jobType = jobType;
    }

    /**
     * @param jobId the event related job id
     * @param jobType the event related job type
     * @param request the event related job request
     * @since 4.1M2
     */
    protected AbstractJobEvent(List jobId, String jobType, Request request)
    {
        this.jobId = jobId;
        this.jobType = jobType;
        this.request = request;
    }

    @Override
    public List getJobId()
    {
        return this.jobId;
    }

    @Override
    public String getJobType()
    {
        return this.jobType;
    }

    @Override
    public Request getRequest()
    {
        return this.request;
    }

    @Override
    public boolean matches(Object event)
    {
        return this.getClass() == event.getClass() && matchesJobId((JobEvent) event)
            && matchesJobType((JobEvent) event);
    }

    /**
     * @param event the event to match
     * @return true if the passed event matches this event, false otherwise.
     */
    private boolean matchesJobId(JobEvent event)
    {
        return this.jobId == null || this.jobId.equals(event.getJobId());
    }

    /**
     * @param event the event to match
     * @return true if the passed event matches this event, false otherwise.
     */
    private boolean matchesJobType(JobEvent event)
    {
        return this.jobType == null || this.jobType.equals(event.getJobType());
    }
}