/**
 * $RCSfile$
 * $Revision: 7071 $
 * $Date: 2007-02-11 18:59:05 -0600 (Sun, 11 Feb 2007) $
 *
 * Copyright 2003-2007 Jive Software.
 *
 * All rights reserved. Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.jivesoftware.smackx.muc;

import org.jivesoftware.smack.packet.Presence;
import org.jivesoftware.smack.util.StringUtils;
import org.jivesoftware.smackx.packet.MUCAdmin;
import org.jivesoftware.smackx.packet.MUCUser;

/**
 * Represents the information about an occupant in a given room. The information
 * will always have the affiliation and role of the occupant in the room. The
 * full JID and nickname are optional.
 * 
 * @author Gaston Dombiak
 */
public class Occupant {
	// Fields that must have a value
	private final String affiliation;
	private final String role;
	// Fields that may have a value
	private final String jid;
	private final String nick;

	Occupant(MUCAdmin.Item item) {
		super();
		jid = item.getJid();
		affiliation = item.getAffiliation();
		role = item.getRole();
		nick = item.getNick();
	}

	Occupant(Presence presence) {
		super();
		final MUCUser mucUser = (MUCUser) presence.getExtension("x",
				"http://jabber.org/protocol/muc#user");
		final MUCUser.Item item = mucUser.getItem();
		jid = item.getJid();
		affiliation = item.getAffiliation();
		role = item.getRole();
		// Get the nickname from the FROM attribute of the presence
		nick = StringUtils.parseResource(presence.getFrom());
	}

	@Override
	public boolean equals(Object obj) {
		if (!(obj instanceof Occupant)) {
			return false;
		}
		final Occupant occupant = (Occupant) obj;
		return jid.equals(occupant.jid);
	}

	/**
	 * Returns the affiliation of the occupant. Possible affiliations are:
	 * "owner", "admin", "member", "outcast". This information will always be
	 * available.
	 * 
	 * @return the affiliation of the occupant.
	 */
	public String getAffiliation() {
		return affiliation;
	}

	/**
	 * Returns the full JID of the occupant. If this information was extracted
	 * from a presence and the room is semi or full-anonymous then the answer
	 * will be null. On the other hand, if this information was obtained while
	 * maintaining the voice list or the moderator list then we will always have
	 * a full JID.
	 * 
	 * @return the full JID of the occupant.
	 */
	public String getJid() {
		return jid;
	}

	/**
	 * Returns the current nickname of the occupant in the room. If this
	 * information was extracted from a presence then the answer will be null.
	 * 
	 * @return the current nickname of the occupant in the room or null if this
	 *         information was obtained from a presence.
	 */
	public String getNick() {
		return nick;
	}

	/**
	 * Returns the current role of the occupant in the room. This information
	 * will always be available.
	 * 
	 * @return the current role of the occupant in the room.
	 */
	public String getRole() {
		return role;
	}

	@Override
	public int hashCode() {
		int result;
		result = affiliation.hashCode();
		result = 17 * result + role.hashCode();
		result = 17 * result + jid.hashCode();
		result = 17 * result + (nick != null ? nick.hashCode() : 0);
		return result;
	}
}