compiler/src/org/apache/flex/swf/tags/RemoveObjectTag.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.swf.tags;

import org.apache.flex.swf.TagType;

/**
 * Represents a <code>RemoveObject</code> tag in a SWF file.
 * <p>
 * The RemoveObject tag removes the specified character (at the specified depth)
 * from the display list.
 */
public class RemoveObjectTag extends Tag implements ICharacterReferrer
{
    /**
     * Constructor.
     */
    public RemoveObjectTag()
    {
        super(TagType.RemoveObject);
    }

    private ICharacterTag character;
    private int depth;

    @Override
    public Iterable<ICharacterTag> getReferences()
    {
        assert character != null;
        return CharacterIterableFactory.from(character);
    }

    /**
     * @return the character
     */
    public ICharacterTag getCharacter()
    {
        return character;
    }

    /**
     * @param character the character to set
     */
    public void setCharacter(ICharacterTag character)
    {
        this.character = character;
    }

    /**
     * @return the depth
     */
    public int getDepth()
    {
        return depth;
    }

    /**
     * @param depth the depth to set
     */
    public void setDepth(int depth)
    {
        this.depth = depth;
    }
}