rocks.xmpp.extensions.muc.model

Class RoomInfo.Builder

java.lang.Object

rocks.xmpp.extensions.data.model.DataForm.Builder<RoomInfo.Builder>

rocks.xmpp.extensions.muc.model.RoomInfo.Builder

Enclosing class:

RoomInfo

public static final class RoomInfo.Builder
extends DataForm.Builder<RoomInfo.Builder>

A builder to build a room info form. The form is of type DataForm.Type.RESULT by default.

Method Summary

Modifier and Type	Method and Description
RoomInfo	build() Builds the room info.
RoomInfo.Builder	changeSubjectAllowed(boolean changeSubjectAllowed) Indicates, whether the room subject can be modified by participants.
RoomInfo.Builder	contacts(Collection<rocks.xmpp.addr.Jid> contacts) Gets the contact addresses (normally, room owner or owners).
RoomInfo.Builder	currentNumberOfOccupants(int occupants) Sets the current number of occupants in the room.
RoomInfo.Builder	description(String description) Sets a short description.
RoomInfo.Builder	language(Locale language) Sets the natural language for room discussions.
RoomInfo.Builder	ldapGroup(String ldapGroup) Sets an associated LDAP group that defines room membership; this should be an LDAP Distinguished Name according to an implementation-specific or deployment-specific definition of a group.
RoomInfo.Builder	logs(URL logs) Sets an URL for archived discussion logs.
RoomInfo.Builder	maxHistoryMessages(int maxHistoryMessages) Sets the maximum number of history messages returned by the room.
RoomInfo.Builder	subject(String subject) Sets the current discussion topic.

Methods inherited from class rocks.xmpp.extensions.data.model.DataForm.Builder

fields, formType, instructions, items, pages, reportedFields, title, type

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

maxHistoryMessages

public RoomInfo.Builder maxHistoryMessages(int maxHistoryMessages)

Sets the maximum number of history messages returned by the room.

Parameters:

maxHistoryMessages - The maximum number of history messages returned by the room.

Returns:

The builder.

contacts

public RoomInfo.Builder contacts(Collection<rocks.xmpp.addr.Jid> contacts)

Gets the contact addresses (normally, room owner or owners).

Parameters:

contacts - The contact addresses.

Returns:

The builder.

description

public RoomInfo.Builder description(String description)

Sets a short description.

Parameters:

description - The description.

Returns:

The builder.

language

public RoomInfo.Builder language(Locale language)

Sets the natural language for room discussions.

Parameters:

language - The language.

Returns:

The builder.

ldapGroup

public RoomInfo.Builder ldapGroup(String ldapGroup)

Sets an associated LDAP group that defines room membership; this should be an LDAP Distinguished Name according to an implementation-specific or deployment-specific definition of a group.

Parameters:

ldapGroup - LDAP group.

Returns:

The builder.

logs

public RoomInfo.Builder logs(URL logs)

Sets an URL for archived discussion logs.

Parameters:

logs - The URL.

Returns:

The builder.

currentNumberOfOccupants

public RoomInfo.Builder currentNumberOfOccupants(int occupants)

Sets the current number of occupants in the room.

Parameters:

occupants - The number of occupants.

Returns:

The builder.

subject

public RoomInfo.Builder subject(String subject)

Sets the current discussion topic.

Parameters:

subject - The topic.

Returns:

The builder.

changeSubjectAllowed

public RoomInfo.Builder changeSubjectAllowed(boolean changeSubjectAllowed)

Indicates, whether the room subject can be modified by participants.

Parameters:

changeSubjectAllowed - Whether the room subject can be modified by participants.

Returns:

The builder.

build

public RoomInfo build()

Builds the room info.

Returns:

The room info.