WeblogEntryPlugin


1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    *  contributor license agreements.  The ASF licenses this file to You
4    * under the Apache License, Version 2.0 (the "License"); you may not
5    * use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.  For additional information regarding
15   * copyright in this work, please see the NOTICE file in the top level
16   * directory of this distribution.
17   */
18  
19  package org.apache.roller.model;
20  
21  import java.util.Map  ;
22  import org.apache.roller.RollerException;
23  import org.apache.roller.pojos.WeblogEntryData;
24  import org.apache.roller.pojos.WebsiteData;
25  
26  
27  /**
28   * Interface for Roller weblog entry plugins.
29   *
30   * Weblog entry plugins are used to make transformations to the entry text.
31   * These plugins affect both the entry summary and entry body.
32   */
33  public interface WeblogEntryPlugin {
34      
35      /**
36       * Returns the display name of this Plugin.
37       */
38      public String   getName();
39      
40      
41      /**
42       * Briefly describes the function of the Plugin.  May contain HTML.
43       */
44      public String   getDescription();
45      
46      
47      /**
48       * Give plugin a chance to initialize and add objects the rendering model.
49       *
50       * @param weblog     Weblog being processed
51       * @param model      Rendering model where objects can be placed
52       */
53      public void init(WebsiteData weblog) throws RollerException;
54      
55      
56      /**
57       * Apply plugin to the specified text.
58       *
59       * @param entry       Entry being rendered.
60       * @param str         String to which plugin should be applied.
61       * @return            Results of applying plugin to entry.
62       */
63      public String   render(WeblogEntryData entry, String   str);
64      
65  }
66
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags