org.schwering.irc.lib.impl.DefaultIRCUser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of irclib Show documentation

A Java Internet Relay Chat library

The newest version!

/**
 * IRClib - A Java Internet Relay Chat library
 * Copyright (C) 2006-2015 Christoph Schwering 
 * and/or other contributors as indicated by the @author tags.
 *
 * This library and the accompanying materials are made available under the
 * terms of the
 *  - GNU Lesser General Public License,
 *  - Apache License, Version 2.0 and
 *  - Eclipse Public License v1.0.
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY.
 */
package org.schwering.irc.lib.impl;

import org.schwering.irc.lib.IRCEventListener;
import org.schwering.irc.lib.IRCUser;
import org.schwering.irc.lib.util.IRCParser;

/**
 * An immutable {@link IRCUser}.
 *
 * @author Christoph Schwering <[email protected]>
 * @see IRCEventListener
 * @see IRCParser
 */
public class DefaultIRCUser implements IRCUser {

    /**
     * The user's nickname.
     */
    private final String nick;

    /**
     * The user's username.
     */
    private final String username;

    /**
     * The user's host.
     */
    private final String host;


    /**
     * Creates a new {@link IRCUser}.
     *
     * @param nick The user's nickname.
     * @param username The user's username.
     * @param host The user's host.
     */
    public DefaultIRCUser(String nick, String username, String host) {
        this.nick = nick;
        this.username = username;
        this.host = host;
    }


    /**
     * @see org.schwering.irc.lib.IRCUser#getNick()
     */
    @Override
    public String getNick() {
        return nick;
    }

    /**
     * @see org.schwering.irc.lib.IRCUser#getUsername()
     */
    @Override
    public String getUsername() {
        return username;
    }


    /**
     * @see org.schwering.irc.lib.IRCUser#getHost()
     */
    @Override
    public String getHost() {
        return host;
    }


    /**
     * @return The nickname.
     */
    public String toString() {
        return getNick();
    }
}