rocks.xmpp.extensions.pubsub.model

Class NodeMetaData

java.lang.Object

rocks.xmpp.extensions.pubsub.model.NodeMetaData

public final class NodeMetaData
extends Object

Represents a standardized DataForm with form type http://jabber.org/protocol/pubsub#meta-data, which can be used to retrieve node meta data.

Usage

To wrap an existing DataForm to retrieve standard data from it, use:

 
 NodeMetaData nodeMetaData = new NodeMetaData(dataForm);
 
 

To build a form:

 
 NodeMetaData nodeMetaData = NodeMetaData.builder()
     .contacts(Collections.singleton(Jid.of("contact")))
     .creationDate(date)
     .creator(Jid.of("creator"))
     .description("desc")
     .language("de")
     .numberOfSubscribers(2)
     .owners(Collections.singleton(Jid.of("owner")))
     .publishers(Collections.singleton(Jid.of("publisher")))
     .title("title")
     .payloadType("namespace")
     .build();
 
 

See Also:

5.4 Discover Node Metadata, 16.4.3 pubsub#meta-data FORM_TYPE

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NodeMetaData.Builder A builder class to build the meta data form.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORM_TYPE

Constructor Summary

Constructors

Constructor and Description
NodeMetaData(DataForm dataForm) Creates a node meta data form.

Method Summary

Modifier and Type	Method and Description
static NodeMetaData.Builder	builder() Creates the builder to build a meta data form.
List<Jid>	getContacts() Gets the contacts.
Instant	getCreationDate() Gets the creation date.
Jid	getCreator() Gets the creator.
DataForm	getDataForm() Gets the underlying data form.
String	getDescription() Gets the description.
Locale	getLanguage() Gets the language.
String	getNodeTitle() Gets the title.
Integer	getNumberOfSubscribers() Gets the number of subscribers.
List<Jid>	getOwners() Gets the owners.
String	getPayloadType() Gets the payload type of the node.
List<Jid>	getPublishers() Gets the publishers.

Methods inherited from class java.lang.Object

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

Field Detail

FORM_TYPE

public static final String FORM_TYPE

See Also:

Constant Field Values

Constructor Detail

NodeMetaData

public NodeMetaData(DataForm dataForm)

Creates a node meta data form.

Parameters:

dataForm - The underlying data form.

Method Detail

builder

public static NodeMetaData.Builder builder()

Creates the builder to build a meta data form.

Returns:

The builder.

getDataForm

public final DataForm getDataForm()

Gets the underlying data form.

Returns:

The underlying data form.

getContacts

public final List<Jid> getContacts()

Gets the contacts.

Returns:

The contacts.

getCreationDate

public final Instant getCreationDate()

Gets the creation date.

Returns:

The creation date.

getCreator

public final Jid getCreator()

Gets the creator.

Returns:

The creator.

getDescription

public final String getDescription()

Gets the description.

Returns:

The description.

getLanguage

public final Locale getLanguage()

Gets the language.

Returns:

The language.

getNumberOfSubscribers

public final Integer getNumberOfSubscribers()

Gets the number of subscribers.

Returns:

The subscribers.

getOwners

public final List<Jid> getOwners()

Gets the owners.

Returns:

The owners.

getPublishers

public final List<Jid> getPublishers()

Gets the publishers.

Returns:

The publishers.

getNodeTitle

public final String getNodeTitle()

Gets the title.

Returns:

The title.

getPayloadType

public final String getPayloadType()

Gets the payload type of the node.

Returns:

The payload type.