compiler/src/main/java/org/apache/royale/compiler/definitions/IEventDefinition.java

/*
 *
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You 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.
 *
 */

package org.apache.royale.compiler.definitions;

import org.apache.royale.compiler.tree.metadata.IEventTagNode;

/**
 * Represents event metadata decorating a class definition,
 * such as <code>Event(name="click", type="flash.events.MouseEvent")]</code>.
 * <p>
 * Use {@link #getBaseName}() to get the event name (e.g., <code>"click"</code>.
 */
public interface IEventDefinition extends IMetadataDefinition
{
    /**
     * Returns the {@link IEventTagNode} from which this definition was created,
     * if the definition came from the AST for a source file.
     * <p>
     * This method may require the AST to be reloaded or regenerated and
     * therefore may be slow.
     */
    @Override
    IEventTagNode getNode();
}