001: /**
002: * Copyright (c) 2003-2007, David A. Czarnecki
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions are met:
007: *
008: * Redistributions of source code must retain the above copyright notice, this list of conditions and the
009: * following disclaimer.
010: * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
011: * following disclaimer in the documentation and/or other materials provided with the distribution.
012: * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
013: * endorse or promote products derived from this software without specific prior written permission.
014: * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
015: * without prior written permission of David A. Czarnecki.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
018: * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
019: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
020: * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
021: * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
022: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
023: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
024: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
025: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
026: * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
027: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
028: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
029: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030: */package org.blojsom.plugin.common;
031:
032: import org.blojsom.blog.Blog;
033: import org.blojsom.blog.Entry;
034: import org.blojsom.plugin.Plugin;
035: import org.blojsom.plugin.PluginException;
036:
037: import javax.servlet.http.HttpServletRequest;
038: import javax.servlet.http.HttpServletResponse;
039: import java.util.Collections;
040: import java.util.List;
041: import java.util.Map;
042:
043: /**
044: * CollectionUtilities plugin
045: *
046: * @author David Czarnecki
047: * @since blojsom 3.0
048: * @version $Id: CollectionUtilitiesPlugin.java,v 1.2 2007/01/17 02:35:09 czarneckid Exp $
049: */
050: public class CollectionUtilitiesPlugin implements Plugin {
051:
052: private static final String BLOJSOM_PLUGIN_COLLECTION_UTILITIES = "BLOJSOM_PLUGIN_COLLECTION_UTILITIES";
053:
054: /**
055: * Construct a new instance of the Collection Utilities plugin
056: */
057: public CollectionUtilitiesPlugin() {
058: }
059:
060: /**
061: * Initialize this plugin. This method only called when the plugin is instantiated.
062: *
063: * @throws org.blojsom.plugin.PluginException
064: * If there is an error initializing the plugin
065: */
066: public void init() throws PluginException {
067: }
068:
069: /**
070: * Process the blog entries
071: *
072: * @param httpServletRequest Request
073: * @param httpServletResponse Response
074: * @param blog {@link Blog} instance
075: * @param context Context
076: * @param entries Blog entries retrieved for the particular request
077: * @return Modified set of blog entries
078: * @throws PluginException If there is an error processing the blog entries
079: */
080: public Entry[] process(HttpServletRequest httpServletRequest,
081: HttpServletResponse httpServletResponse, Blog blog,
082: Map context, Entry[] entries) throws PluginException {
083: context.put(BLOJSOM_PLUGIN_COLLECTION_UTILITIES,
084: new CollectionUtilities());
085:
086: return entries;
087: }
088:
089: /**
090: * Perform any cleanup for the plugin. Called after {@link #process}.
091: *
092: * @throws org.blojsom.plugin.PluginException
093: * If there is an error performing cleanup for this plugin
094: */
095: public void cleanup() throws PluginException {
096: }
097:
098: /**
099: * Called when BlojsomServlet is taken out of service
100: *
101: * @throws org.blojsom.plugin.PluginException
102: * If there is an error in finalizing this plugin
103: */
104: public void destroy() throws PluginException {
105: }
106:
107: /**
108: * Utility class for collection utility functions to make available to templates
109: */
110: public class CollectionUtilities {
111:
112: /**
113: * Construct a new instance of CollectionUtilities
114: */
115: public CollectionUtilities() {
116: }
117:
118: /**
119: * Reverse a list
120: *
121: * @param input List to be reversed
122: * @return List in reverse order
123: */
124: public List reverse(List input) {
125: if (input == null || input.size() == 0) {
126: return input;
127: }
128:
129: Collections.reverse(input);
130:
131: return input;
132: }
133: }
134: }
|