DMDirc-Client/api/src/main/java/com/dmdirc/interfaces/User.java

/*
 * Copyright (c) 2006-2015 DMDirc Developers
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.dmdirc.interfaces;

import com.dmdirc.parser.common.AwayState;

import java.util.Collection;
import java.util.Optional;

/**
 * Holds information about a {@link User} on a {@link Connection}
 */
public interface User {

    /**
     * Retrieves the nickname or display name used by this client.
     *
     * @return This client's nickname
     */
    String getNickname();

    /**
     * Retrieves the username or ident used by this client.
     *
     * @return This client's username
     */
    Optional<String> getUsername();

    /**
     * Retrieves the hostname that this client is connecting from.
     *
     * @return This client's hostname
     */
    Optional<String> getHostname();

    /**
     * Retrieves the full/real name of the client.
     *
     * @return This client's real name
     */
    Optional<String> getRealname();

    /**
     * Retries the {@link GroupChat}s the client is a member of.
     *
     * @return Collection of {@link GroupChat}s, may be empty
     */
    Collection<GroupChat> getGroupChats();

    /**
     * Returns the away message for the client, if the away message is empty the user is not away.
     *
     * @return Optional.empty if the user is not away, wrapped away reason if they are
     */
    Optional<String> getAwayMessage();

    /**
     * Returns the away state for this user.
     *
     * @return The user's away state
     */
    AwayState getAwayState();

    /**
     * Gets the {@link Connection} for this client.
     *
     * @return Non-Null connection for this connection
     */
    Connection getConnection();
}