NodeMetaData (Babbler 0.5.1)

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(Arrays.asList(Jid.valueOf("contact")))
     .creationDate(date)
     .creator(Jid.valueOf("creator"))
     .description("desc")
     .language("de")
     .numberOfSubscribers(2)
     .owners(Arrays.asList(Jid.valueOf("owner")))
     .publishers(Arrays.asList(Jid.valueOf("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.

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

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.

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

Method Summary

Methods
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.
`Date`	`getCreationDate()` Gets the creation date.
`Jid`	`getCreator()` Gets the creator.
`DataForm`	`getDataForm()` Gets the underlying data form.
`String`	`getDescription()` Gets the description.
`String`	`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 DataForm getDataForm()
```
    Gets the underlying data form.
    
    Returns:
    The underlying data form.
  - getContacts
```
public List<Jid> getContacts()
```
    Gets the contacts.
    
    Returns:
    The contacts.
  - getCreationDate
```
public Date getCreationDate()
```
    Gets the creation date.
    
    Returns:
    The creation date.
  - getCreator
```
public Jid getCreator()
```
    Gets the creator.
    
    Returns:
    The creator.
  - getDescription
```
public String getDescription()
```
    Gets the description.
    
    Returns:
    The description.
  - getLanguage
```
public String getLanguage()
```
    Gets the language.
    
    Returns:
    The language.
  - getNumberOfSubscribers
```
public Integer getNumberOfSubscribers()
```
    Gets the number of subscribers.
    
    Returns:
    The subscribers.
  - getOwners
```
public List<Jid> getOwners()
```
    Gets the owners.
    
    Returns:
    The owners.
  - getPublishers
```
public List<Jid> getPublishers()
```
    Gets the publishers.
    
    Returns:
    The publishers.
  - getNodeTitle
```
public String getNodeTitle()
```
    Gets the title.
    
    Returns:
    The title.
  - getPayloadType
```
public String getPayloadType()
```
    Gets the payload type of the node.
    
    Returns:
    The payload type.

Class NodeMetaData

Usage

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FORM_TYPE

Constructor Detail

NodeMetaData

Method Detail

builder

getDataForm

getContacts

getCreationDate

getCreator

getDescription

getLanguage

getNumberOfSubscribers

getOwners

getPublishers

getNodeTitle

getPayloadType