netbout-spi-1.5.6.src.main.java.com.netbout.spi.Message Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2012, Netbout.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met: 1) Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer. 2) 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. 3) Neither the name of the NetBout.com 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 HOLDER 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 com.netbout.spi;
import java.util.Date;
/**
* Single message in a {@link Bout}.
*
* Messages are comparable by their numbers.
*
*
Instances of this interface must be thread-safe.
*
* @author Yegor Bugayenko ([email protected])
* @version $Id: Message.java 3470 2012-10-16 18:46:28Z [email protected] $
*/
public interface Message extends Comparable {
/**
* Unique number of the message, in the entire system.
* @return The number
*/
Long number();
/**
* Author of this message, his identity.
* @return The author
*/
Friend author();
/**
* Text of the message.
*
* As soon as you call this method the message considers to be
* "seen" and the next call to {@link #seen()} should return TRUE. Until
* this method is called {@link #seen()} sould return FALSE.
*
* @return The text of the message, in UTF-8
*/
String text();
/**
* Date when it was posted by the author.
* @return The date
*/
Date date();
/**
* This message has been already seen by the viewer?
* @return Did he see it or not?
*/
Boolean seen();
}