KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > macro > MacroExpansionUtilities


1 /**
2  * Copyright (c) 2003-2006, David A. Czarnecki
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * Redistributions of source code must retain the above copyright notice, this list of conditions and the
9  * following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
11  * following disclaimer in the documentation and/or other materials provided with the distribution.
12  * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
13  * endorse or promote products derived from this software without specific prior written permission.
14  * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
15  * without prior written permission of David A. Czarnecki.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
18  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
19  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
21  * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 package org.blojsom.plugin.macro;
32
33 import org.blojsom.blog.Blog;
34
35 import java.util.Map JavaDoc;
36 import java.util.HashMap JavaDoc;
37 import java.util.Iterator JavaDoc;
38
39 /**
40  * Macro expansion utilities
41  *
42  * @author David Czarnecki
43  * @since blojsom 3.0
44  * @version $Id: MacroExpansionUtilities.java,v 1.1 2006/03/20 21:30:56 czarneckid Exp $
45  */
46 public class MacroExpansionUtilities {
47
48     public static final String JavaDoc PLUGIN_MACRO_PREFIX = "plugin-macro-";
49
50     /**
51      * Read in the macros from the specified configuration file in the user's directory
52      *
53      * @param blog {@link Blog}
54      * @return Macros as a {@link java.util.Map}
55      */
56     public static Map JavaDoc readMacros(Blog blog) {
57         Map JavaDoc macros = new HashMap JavaDoc();
58         Map JavaDoc blogProperties = blog.getProperties();
59         Iterator JavaDoc propertyIterator = blogProperties.keySet().iterator();
60
61         while (propertyIterator.hasNext()) {
62             String JavaDoc property = (String JavaDoc) propertyIterator.next();
63             if (property.startsWith(PLUGIN_MACRO_PREFIX)) {
64                 macros.put(property.substring(property.indexOf(PLUGIN_MACRO_PREFIX) + PLUGIN_MACRO_PREFIX.length()), blogProperties.get(property));
65             }
66         }
67
68         return macros;
69     }
70 }
71
Popular Tags