com.netbout.spi.Messages Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2016, netbout.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are PROHIBITED without prior written permission from
* the author. This product may NOT be used anywhere and on any computer
* except the server platform of netbout Inc. located at www.netbout.com.
* Federal copyright law prohibits unauthorized reproduction by any means
* and imposes fines up to $25,000 for violation. If you received
* this code accidentally and without intent to use it, please report this
* incident to the author by email.
*
* 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 com.netbout.spi;
import com.jcabi.aspects.Immutable;
import java.io.IOException;
/**
* Bout messages.
*
* @author Yegor Bugayenko ([email protected])
* @version $Id: 6760e2d9a131fda1f0c4f44beb08acd564ee5e65 $
* @since 2.0
*/
@Immutable
public interface Messages extends Pageable, Searchable {
/**
* Page size.
*/
int PAGE = 16;
/**
* Post a new message.
* @param text The text of the new message
* @throws IOException If fails
*/
void post(String text) throws IOException;
/**
* How many unread messages are there?
* @return Number of them
* @throws IOException If fails
*/
long unread() throws IOException;
/**
* Message content is not valid.
*/
final class BrokenPostException extends IOException {
/**
* Serialization marker.
*/
private static final long serialVersionUID = -6379382623897037014L;
/**
* Ctor.
* @param cause Cause of the problem
*/
public BrokenPostException(final String cause) {
super(cause);
}
}
}