/* 
    P/P   *  Method: net.sourceforge.pebble.logging.LogSummary__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.logging;
    33  
    34  import net.sourceforge.pebble.domain.Blog;
    35  
    36  import java.util.Date;
    37  
    38  /**
    39   * Represents a summary of a log.
    40   *
    41   * @author    Simon Brown
    42   */
    43  public abstract class LogSummary {
    44  
    45    /** the blog that this instance is associated with */
    46    private Blog blog;
    47  
    48    /** the date that this summary represents */
    49    private Date date;
    50  
    51    /** the total number of requests */
    52    private int totalRequests;
    53  
    54    /**
    55     * Creates a new log summary associated with the given blog.
    56     *
    57     * @param blog          a Blog instance
    58     */
           /* 
    P/P     *  Method: void net.sourceforge.pebble.logging.LogSummary(Blog, Date)
            * 
            *  Postconditions:
            *    this.blog == blog
            *    init'ed(this.blog)
            *    this.date == date
            *    init'ed(this.date)
            */
    59    LogSummary(Blog blog, Date date) {
    60      this.blog = blog;
    61      this.date = date;
    62    }
    63  
    64    /**
    65     * Gets the date that this log summary is for.
    66     *
    67     * @return    a Date instance
    68     */
    69    public Date getDate() {
             /* 
    P/P       *  Method: Date getDate()
              * 
              *  Preconditions:
              *    init'ed(this.date)
              * 
              *  Postconditions:
              *    return_value == this.date
              *    init'ed(return_value)
              */
    70      return this.date;
    71    }
    72  
    73    /**
    74     * Gets the total number of requests.
    75     *
    76     * @return  the total number as an int
    77     */
    78    public abstract int getTotalRequests();
    79  
    80  }