IEffectTagNode.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.flex.compiler.tree.metadata;

import org.apache.flex.compiler.tree.as.IDefinitionNode;
import org.apache.flex.compiler.tree.as.IDocumentableDefinitionNode;

/**
 * Represents an Effect metadata tag, of the form [Effect(name="string",
 * event="eventName")]
 */
public interface IEffectTagNode extends IDefinitionNode, IMetaTagNode, IEventTriggerTagNode, IDocumentableDefinitionNode
{
    /**
     * Gets the name of the event that triggers the effect.
     * 
     * @return The name of the event that triggers the effect, never null.
     */
    String getEventName();
}