org.fujion.event.TimerEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fujion-core Show documentation

There is a newer version: 3.1.0

/*
 * #%L
 * fujion
 * %%
 * Copyright (C) 2008 - 2017 Regenstrief Institute, Inc.
 * %%
 * 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.
 *
 * #L%
 */
package org.fujion.event;

import org.fujion.annotation.EventType;
import org.fujion.annotation.EventType.EventParameter;
import org.fujion.component.BaseComponent;

/**
 * A timer event.
 */
@EventType(TimerEvent.TYPE)
public class TimerEvent extends Event {

    /**
     * The event type.
     */
    public static final String TYPE = "timer";

    @EventParameter
    private int count;

    @EventParameter
    private boolean running;

    public TimerEvent() {
        super(TYPE);
    }

    public TimerEvent(BaseComponent target, Object data) {
        super(TYPE, target, data);
    }

    /**
     * Returns the number of times the timer has fired.
     *
     * @return The number of times the timer has fired.
     */
    public int getCount() {
        return count;
    }

    /**
     * Returns true if the timer is running.
     *
     * @return True if the timer is running.
     */
    public boolean isRunning() {
        return running;
    }

}