View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.doxia.macro;
20  
21  import java.util.Map;
22  
23  import org.apache.maven.doxia.sink.SinkEventAttributes;
24  import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet;
25  
26  /**
27   * Abstract base class to execute <code>Macro</code>.
28   *
29   * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
30   * @since 1.0
31   */
32  public abstract class AbstractMacro implements Macro {
33      /**
34       * Convert the Map of macro parameters to an AttributeSet.
35       * No check of validity is done, all parameters are added.
36       *
37       * @param parameters the macro parameters.
38       * @return a SinkEventAttributeSet containing the same parameters,
39       *  or null if parameters is null.
40       * @since 1.1.1.
41       */
42      protected static SinkEventAttributes getAttributesFromMap(Map<?, ?> parameters) {
43          if (parameters == null) {
44              return null;
45          }
46  
47          final int count = parameters.size();
48  
49          if (count <= 0) {
50              return null;
51          }
52  
53          final SinkEventAttributeSet atts = new SinkEventAttributeSet(count);
54  
55          for (Map.Entry<?, ?> entry : parameters.entrySet()) {
56              atts.addAttribute(entry.getKey(), entry.getValue());
57          }
58  
59          return atts;
60      }
61  }