uk.org.retep.xmpp.muc.MucRoomMember Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 1998-2010, Peter T Mount

 * All rights reserved.
 *
 * 
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 3 of the License, or
 *   (at your option) any later version.
 * 
 *
 * 
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 * 
 *
 * 
 *   You should have received a copy of the GNU General Public License along
 *   with this program.  If not, see .
 * 
 *
 * 
 *        GNU GENERAL PUBLIC LICENSE - CLASSPATH EXCEPTION
 * 
 *
 * 
 *   Linking this library statically or dynamically with other modules
 *   is making a combined work based on this library. Thus, the terms
 *   and conditions of the GNU General Public License cover the whole
 *   combination.
 * 
 *
 * 
 *   As a special exception, the copyright holders of this library give
 *   you permission to link this library with independent modules to
 *   produce an executable, regardless of the license terms of these
 *   independent modules, and to copy and distribute the resulting
 *   executable under terms of your choice, provided that you also meet,
 *   for each linked independent module, the terms and conditions of the
 *   license of that module.
 * 
 *
 * 
 *   An independent module is a module which is either not derived from or based
 *   on this library, or a module who's classes extend those within this library
 *   as part of the implementation of the library.
 * 
 *
 * 
 *   If you modify this library, you may extend this exception to your version
 *   of the library, but you are not obligated to do so. If you do not wish to
 *   do so, delete this exception statement from your version.
 * 
 */
package uk.org.retep.xmpp.muc;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import uk.org.retep.xmpp.JID;
import uk.org.retep.xmpp.util.Affiliation;
import uk.org.retep.xmpp.util.Role;

/**
 *
 * @author peter
 */
public interface MucRoomMember
{

    /**
     * The member's nickname
     * @return
     */
    @Nonnull
    String getNickname();

    /**
     * The member's nickname
     * @param nickname
     */
    void setNickname( @Nonnull final String nickname );

    /**
     * The members true JID (not the one in the room)
     * @return
     */
    @Nonnull
    JID getJID();

    void setJID( @Nonnull JID jid );

    /**
     * The members {@link Affiliation} in the room
     * @return affilitation
     */
    @Nonnull
    Affiliation getAffiliation();

    /**
     * Sets the {@link Affiliation} for the member. Using this method will bypass
     * any checks on affiliation as those checks are done higher up.
     * @param affiliation Affiliation or {@link Affiliation#NONE} if null
     */
    void setAffiliation( @Nullable Affiliation affiliation );

    /**
     * The members {@link Role} in the room
     * @return role
     */
    @Nonnull
    Role getRole();

    /**
     * Sets the {@link Role} for the member. Using this method will bypass
     * any checks on role as those checks are done higher up.
     * @param role Role or {@link Role#NONE} if null
     */
    void setRole( @Nullable Role role );

    /**
     * Optional persistent nickname of the member as defined by
     * .
     *
     * @return Persistent nickname or null if not used
     */
    @Nullable
    String getPersistentNickname();

    /**
     * Sets the optional persistent nickname of the member as defined by
     * .
     *
     * Normally this is set to null, but if present will be included in all
     * presence messages sent by the service
     * 
     * @param nickname
     */
    void setPersistentNickname( @Nullable String nickname );
}
Related Artifacts