View Javadoc

1   package org.apache.maven.doxia.macro;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.doxia.sink.Sink;
23  
24  import org.apache.maven.doxia.sink.SinkEventAttributeSet;
25  import org.codehaus.plexus.component.annotations.Component;
26  
27  /**
28   * A simple macro that prints out the key and value of some supplied parameters.
29   *
30   * @version $Id: EchoMacro.java 1345590 2012-06-02 21:36:10Z hboutemy $
31   */
32  @Component( role = Macro.class, hint = "echo" )
33  public class EchoMacro
34      extends AbstractMacro
35  {
36      /** {@inheritDoc} */
37      public void execute( Sink sink, MacroRequest request )
38      {
39          sink.verbatim( SinkEventAttributeSet.BOXED );
40  
41          sink.text( "echo" + EOL );
42  
43          for ( String key : request.getParameters().keySet() )
44          {
45              // TODO: DOXIA-242: separate or define internal params
46              if ( "parser".equals( key ) || "sourceContent".equals( key ) )
47              {
48                  continue;
49              }
50  
51              sink.text( key + " ---> " + request.getParameter( key ) + EOL );
52          }
53  
54          sink.verbatim_();
55      }
56  }