contentdecorator.java

pebble-blog 博客源码博客源码博客源码

/*
 * Copyright (c) 2003-2006, Simon Brown
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   - Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   - Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   - Neither the name of Pebble nor the names of its contributors may
 *     be used to endorse or promote products derived from this software
 *     without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package net.sourceforge.pebble.api.decorator;

import net.sourceforge.pebble.domain.*;

/**
 * Interface implemented by content decorators. Decorators are created on a
 * per blog basis, meaning that multiple threads can be operating on an
 * instance at any one time.
 *
 * @author    Simon Brown
 */
public interface ContentDecorator {

  /**
   * Decorates the specified blog entry.
   *
   * @param context     the context in which the decoration is running
   * @param blogEntry   the blog entry to be decorated
   */
  public void decorate(ContentDecoratorContext context, BlogEntry blogEntry);

  /**
   * Decorates the specified comment.
   *
   * @param context     the context in which the decoration is running
   * @param comment     the comment to be decorated
   */
  public void decorate(ContentDecoratorContext context, Comment comment);

  /**
   * Decorates the specified TrackBack.
   *
   * @param context     the context in which the decoration is running
   * @param trackBack   the TrackBack to be decorated
   */
  public void decorate(ContentDecoratorContext context, TrackBack trackBack);

  /**
   * Decorates the specified static page.
   *
   * @param context       the context in which the decoration is running
   * @param staticPage    the static page to be decorated
   */
  public void decorate(ContentDecoratorContext context, StaticPage staticPage);

  /**
   * Gets the blog to which this decorator is associated.
   *
   * @return  a Blog instance
   */
  public Blog getBlog();

  /**
   * Sets the blog to which this decorator is associated.
   *
   * @param blog    a Blog instance
   */
  public void setBlog(Blog blog);

}