MacroBlockMatcher.java

/*
 * 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.rendering.block.match;

import org.xwiki.rendering.block.Block;
import org.xwiki.rendering.block.MacroBlock;

/**
 * Implementation of {@link BlockMatcher} which matches {@link org.xwiki.rendering.block.MacroBlock}s.
 *
 * @version $Id: 4c636cc250d9cd2870284cf36561a78b830fae36 $
 * @since 3.0RC1
 */
public class MacroBlockMatcher extends ClassBlockMatcher
{
    /**
     * The macro id to match.
     */
    private String macroId;

    /**
     * Match {@link org.xwiki.rendering.block.MacroBlock} having the passed id.
     *
     * @param macroId the macro id to match
     */
    public MacroBlockMatcher(String macroId)
    {
        super(MacroBlock.class);
        this.macroId = macroId;
    }

    @Override
    public boolean match(Block block)
    {
        return super.match(block) && ((MacroBlock) block).getId().equals(this.macroId);
    }
}