001package org.apache.maven.doxia.macro;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.maven.doxia.sink.Sink;
023
024import org.apache.maven.doxia.sink.SinkEventAttributeSet;
025import org.codehaus.plexus.component.annotations.Component;
026
027/**
028 * A simple macro that prints out the key and value of some supplied parameters.
029 *
030 * @version $Id$
031 */
032@Component( role = Macro.class, hint = "echo" )
033public class EchoMacro
034    extends AbstractMacro
035{
036    /** {@inheritDoc} */
037    public void execute( Sink sink, MacroRequest request )
038    {
039        sink.verbatim( SinkEventAttributeSet.BOXED );
040
041        sink.text( "echo" + EOL );
042
043        for ( String key : request.getParameters().keySet() )
044        {
045            // TODO: DOXIA-242: separate or define internal params
046            if ( "parser".equals( key ) || "sourceContent".equals( key ) )
047            {
048                continue;
049            }
050
051            sink.text( key + " ---> " + request.getParameter( key ) + EOL );
052        }
053
054        sink.verbatim_();
055    }
056}