uk.org.retep.xmpp.muc.builder.MucRoomSetBuilder Maven / Gradle / Ivy
/*
* 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.builder;
import javax.annotation.Nonnull;
import uk.org.retep.xmpp.JID;
import uk.org.retep.util.builder.impl.AbstractBuilder;
import uk.org.retep.xmpp.muc.MucRoomSet;
import uk.org.retep.xmpp.muc.beans.BasicMucRoomSet;
/**
* Builder to create a {@link MucRoomSet}.
*
*
* This will simply create a {@link BasicMucRoomSet} but subclasses may
* build custom implementations.
*
*
* @author peter
* @since 9.12
*/
public class MucRoomSetBuilder
extends AbstractBuilder
{
private JID serviceJid;
/**
* Set's the serviceJid for this {@link MucRoomSet}.
*
* This is set by {@link MucServiceBuilder} during the build phase
* so that the instance is the same one used by the service being built.
*
* @param serviceJid JID of the service
* @return
*/
final B setServiceJid( @Nonnull final JID serviceJid )
{
this.serviceJid = serviceJid;
return getThis();
}
/**
* The serviceJid set during the build phase of a MucService.
*
*
* Subclasses should use this method if they subclass this builder.
*
*
* @return service JID
*/
@Nonnull
protected final JID getServiceJid()
{
return serviceJid;
}
/**]
* {@inheritDoc}
*/
@Override
public MucRoomSet build()
{
if( serviceJid == null )
{
throw new IllegalArgumentException( "serviceJid not set" );
}
return new BasicMucRoomSet( serviceJid );
}
}