l2jserver2/src/main/java/com/l2jserver/model/world/Clan.java

/*
 * This file is part of l2jserver <l2jserver.com>.
 *
 * l2jserver 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.
 *
 * l2jserver 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 l2jserver.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.l2jserver.model.world;

import java.util.Iterator;

import com.l2jserver.model.id.object.CharacterID;
import com.l2jserver.model.id.object.ClanID;
import com.l2jserver.model.id.object.iterator.WorldObjectIterator;
import com.l2jserver.model.world.clan.ClanMembers;

/**
 * This class represents an clan in the Lineage II world
 * 
 * @author <a href="http://www.rogiel.com">Rogiel</a>
 */
public class Clan extends AbstractObject implements Iterable<L2Character> {
	/**
	 * Clan leader
	 */
	private CharacterID leaderID;

	/**
	 * Members in the clan
	 */
	private final ClanMembers members = new ClanMembers(this);

	/**
	 * @return the leaderID
	 */
	public CharacterID getLeaderID() {
		return leaderID;
	}

	/**
	 * @return the leader
	 */
	public L2Character getLeader() {
		return leaderID.getObject();
	}

	/**
	 * @param leaderID
	 *            the leaderID to set
	 */
	public void setLeaderID(CharacterID leaderID) {
		this.leaderID = leaderID;
	}

	/**
	 * @return the members
	 */
	public ClanMembers getMembers() {
		return members;
	}

	@Override
	public ClanID getID() {
		return (ClanID) super.getID();
	}

	@Override
	public Iterator<L2Character> iterator() {
		return new WorldObjectIterator<L2Character>(members.iterator());
	}
}