uk.org.retep.xmpp.muc.builder.MucRoomMemberBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of multiUserChat Show documentation
The newest version!
/*
 * 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 javax.annotation.Nullable;
import uk.org.retep.util.builder.Builder;
import uk.org.retep.util.builder.BuilderFactory;
import uk.org.retep.util.builder.impl.AbstractBuilder;
import uk.org.retep.xmpp.JID;
import uk.org.retep.xmpp.JIDBuilder;
import uk.org.retep.xmpp.muc.MucAuthenticator;
import uk.org.retep.xmpp.muc.MucRoomMember;
import uk.org.retep.xmpp.muc.beans.BasicMucAuthenticator;
import uk.org.retep.xmpp.muc.beans.BasicMucRoomMember;
import uk.org.retep.xmpp.util.Affiliation;
import uk.org.retep.xmpp.util.AffiliationBuilder;
import uk.org.retep.xmpp.util.Role;
import uk.org.retep.xmpp.util.RoleBuilder;

/**
 * Builds a {@link MucAuthenticator}.
 *
 * The default implementation simply returns a new {@link BasicMucAuthenticator}
 * but this builder exists to allow subclasses to implement their own implementation
 * 
 * @param  Type of subclass
 * @author peter
 */
public class MucRoomMemberBuilder
        extends AbstractBuilder
{

    private JIDBuilder jidBuilder;
    private AffiliationBuilder affilitation = Affiliation.NONE.cloneBuilder();
    private RoleBuilder role = Role.VISITOR.cloneBuilder();
    private Builder nickNameBuilder = null;

    @Nonnull
    public final B setJidBuilder( @Nonnull final JIDBuilder jidBuilder )
    {
        this.jidBuilder = jidBuilder;
        return getThis();
    }

    @Nonnull
    public final B setJid( @Nullable final JID jid )
    {
        return setJidBuilder( jid == null ? null : jid.cloneBuilder() );
    }

    @Nonnull
    public final B setAffilitation( @Nullable final Affiliation affilitation )
    {
        return setAffilitation( (affilitation == null ? Affiliation.NONE : affilitation).cloneBuilder() );
    }

    @Nonnull
    public final B setAffilitation( @Nonnull final AffiliationBuilder affilitation )
    {
        this.affilitation = affilitation;
        return getThis();
    }

    @Nonnull
    public final B setRole( @Nullable final Role role )
    {
        return setRole( (role == null ? Role.NONE : role).cloneBuilder() );
    }

    @Nonnull
    public final B setRole( @Nonnull final RoleBuilder role )
    {
        this.role = role;
        return getThis();
    }

    @Nonnull
    public final B setNickName( @Nullable final String nickName )
    {
        return setNickNameBuilder( BuilderFactory.createBuilder( nickName ) );
    }

    @Nonnull
    public final B setNickName( @Nonnull final String format, @Nonnull final Object... args )
    {
        return setNickNameBuilder( BuilderFactory.createFormatBuilder( format, args ) );
    }

    @Nonnull
    public final B setNickNameBuilder( @Nullable final Builder nickNameBuilder )
    {
        this.nickNameBuilder = nickNameBuilder;
        return getThis();
    }

    @Nonnull
    protected final AffiliationBuilder getAffilitation()
    {
        return affilitation;
    }

    @Nonnull
    protected final RoleBuilder getRole()
    {
        return role;
    }

    @Nullable
    protected final Builder getNickNameBuilder()
    {
        return nickNameBuilder;
    }

    @Nonnull
    @Override
    public MucRoomMember build()
    {
        final MucRoomMember member = new BasicMucRoomMember();

        member.setJID( jidBuilder.build() );
        member.setAffiliation( affilitation.build() );
        member.setRole( role.build() );
        member.setNickname( BuilderFactory.build( nickNameBuilder ) );

        return member;
    }

    /**
     * Subclasses must implement this to create a specific implementation
     *
     * @return implementation of {@link MucRoomMember}
     */
    @Nonnull
    protected MucRoomMember createNewInstance()
    {
        return new BasicMucRoomMember();
    }
}