KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > common > ConvertLineBreaksPlugin


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.common;
32
33 import org.blojsom.blog.Blog;
34 import org.blojsom.blog.Entry;
35 import org.blojsom.plugin.Plugin;
36 import org.blojsom.plugin.PluginException;
37 import org.blojsom.util.BlojsomUtils;
38
39 import javax.servlet.http.HttpServletRequest JavaDoc;
40 import javax.servlet.http.HttpServletResponse JavaDoc;
41 import java.util.Map JavaDoc;
42
43 /**
44  * Convert Line Breaks Plugin
45  *
46  * @author David Czarnecki
47  * @version $Id: ConvertLineBreaksPlugin.java,v 1.1 2006/03/20 21:30:54 czarneckid Exp $
48  * @since blojsom 3.0
49  */
50 public class ConvertLineBreaksPlugin implements Plugin {
51
52     /**
53      * Default constructor.
54      */
55     public ConvertLineBreaksPlugin() {
56     }
57
58     /**
59      * Initialize this plugin. This method only called when the plugin is instantiated.
60      *
61      * @throws org.blojsom.plugin.PluginException
62      * If there is an error initializing the plugin
63      */
64     public void init() throws PluginException {
65     }
66
67     /**
68      * Process the blog entries
69      *
70      * @param httpServletRequest Request
71      * @param httpServletResponse Response
72      * @param blog {@link Blog} instance
73      * @param context Context
74      * @param entries Blog entries retrieved for the particular request
75      * @return Modified set of blog entries
76      * @throws PluginException If there is an error processing the blog entries
77      */
78     public Entry[] process(HttpServletRequest JavaDoc httpServletRequest, HttpServletResponse JavaDoc httpServletResponse, Blog blog, Map JavaDoc context, Entry[] entries) throws PluginException {
79         for (int i = 0; i < entries.length; i++) {
80             Entry entry = entries[i];
81             String JavaDoc description = entry.getDescription();
82             if (!BlojsomUtils.checkNullOrBlank(description)) {
83                 description = BlojsomUtils.replace(description, "\n", "<br />");
84                 entry.setDescription(description);
85             }
86         }
87
88         return entries;
89     }
90
91     /**
92      * Perform any cleanup for the plugin. Called after {@link #process}.
93      *
94      * @throws org.blojsom.plugin.PluginException
95      * If there is an error performing cleanup for this plugin
96      */
97     public void cleanup() throws PluginException {
98     }
99
100     /**
101      * Called when BlojsomServlet is taken out of service
102      *
103      * @throws org.blojsom.plugin.PluginException
104      * If there is an error in finalizing this plugin
105      */
106     public void destroy() throws PluginException {
107     }
108 }
Popular Tags