/* 
    P/P   *  Method: net.sourceforge.pebble.api.decorator.ContentDecorator__static_init
          */
     1  /*
     2   * Copyright (c) 2003-2006, Simon Brown
     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
     9   *     notice, this list of conditions and the following disclaimer.
    10   *
    11   *   - Redistributions in binary form must reproduce the above copyright
    12   *     notice, this list of conditions and the following disclaimer in
    13   *     the documentation and/or other materials provided with the
    14   *     distribution.
    15   *
    16   *   - Neither the name of Pebble nor the names of its contributors may
    17   *     be used to endorse or promote products derived from this software
    18   *     without specific prior written permission.
    19   *
    20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    30   * POSSIBILITY OF SUCH DAMAGE.
    31   */
    32  package net.sourceforge.pebble.api.decorator;
    33  
    34  import net.sourceforge.pebble.domain.*;
    35  
    36  /**
    37   * Interface implemented by content decorators. Decorators are created on a
    38   * per blog basis, meaning that multiple threads can be operating on an
    39   * instance at any one time.
    40   *
    41   * @author    Simon Brown
    42   */
    43  public interface ContentDecorator {
    44  
    45    /**
    46     * Decorates the specified blog entry.
    47     *
    48     * @param context     the context in which the decoration is running
    49     * @param blogEntry   the blog entry to be decorated
    50     */
    51    public void decorate(ContentDecoratorContext context, BlogEntry blogEntry);
    52  
    53    /**
    54     * Decorates the specified comment.
    55     *
    56     * @param context     the context in which the decoration is running
    57     * @param comment     the comment to be decorated
    58     */
    59    public void decorate(ContentDecoratorContext context, Comment comment);
    60  
    61    /**
    62     * Decorates the specified TrackBack.
    63     *
    64     * @param context     the context in which the decoration is running
    65     * @param trackBack   the TrackBack to be decorated
    66     */
    67    public void decorate(ContentDecoratorContext context, TrackBack trackBack);
    68  
    69    /**
    70     * Decorates the specified static page.
    71     *
    72     * @param context       the context in which the decoration is running
    73     * @param staticPage    the static page to be decorated
    74     */
    75    public void decorate(ContentDecoratorContext context, StaticPage staticPage);
    76  
    77    /**
    78     * Gets the blog to which this decorator is associated.
    79     *
    80     * @return  a Blog instance
    81     */
    82    public Blog getBlog();
    83  
    84    /**
    85     * Sets the blog to which this decorator is associated.
    86     *
    87     * @param blog    a Blog instance
    88     */
    89    public void setBlog(Blog blog);
    90  
    91  }