/* 
    P/P   *  Method: org.apache.roller.weblogger.business.plugins.comment.WeblogEntryCommentPlugin__static_init
          */
     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.weblogger.business.plugins.comment;
    20  
    21  import org.apache.roller.weblogger.pojos.WeblogEntryComment;
    22  
    23  
    24  /**
    25   * Interface for weblog entry comment plugins.
    26   *
    27   * Weblog entry comment plugins are used to make transformations to comment text.
    28   */
    29  public interface WeblogEntryCommentPlugin {
    30      
    31      /**
    32       * A unique identifier for the plugin.
    33       */
    34      public String getId();
    35      
    36      
    37      /**
    38       * Returns the display name of this Plugin.
    39       */
    40      public String getName();
    41      
    42      
    43      /**
    44       * Briefly describes the function of the Plugin.  May contain HTML.
    45       */
    46      public String getDescription();
    47      
    48      
    49      /**
    50       * Apply plugin to the specified text.
    51       *
    52       * @param entry       Entry being rendered.
    53       * @param str         String to which plugin should be applied.
    54       * @return            Results of applying plugin to string.
    55       */
    56      public String render(final WeblogEntryComment comment, String str);
    57      
    58  }