Package rocks.xmpp.extensions.seclabel.model.catalog

Class Catalog

java.lang.Object

rocks.xmpp.extensions.seclabel.model.catalog.Catalog

public final class Catalog
extends Object

The implementation of the <catalog/> element in the urn:xmpp:sec-label:catalog:2 namespace.

See Also:

XEP-0258: Security Labels in XMPP, XML Schema

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Catalog.Item	A catalog item.

Constructor Summary

Constructors

Constructor	Description
Catalog()
Catalog(Jid to, Jid from, String name, String description, String id, Integer size, Boolean restrict, Collection<Catalog.Item> items)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the description.
Jid	getFrom()	Gets the 'from' attribute.
String	getId()	Identifier for current revision, commonly a hash.
List<Catalog.Item>	getItems()	Gets the catalog items.
String	getName()	Gets the catalog name.
Integer	getSize()	Gets the number of items.
Jid	getTo()	Gets the 'to' attribute.
boolean	isRestrictive()	If catalog is restrictive, the client SHOULD restrict the user to choosing one of the items from the catalog and use the label of that item (or no label if the selected item is empty).

Methods inherited from class java.lang.Object

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

Constructor Detail

Catalog

public Catalog()

Catalog

public Catalog(Jid to,
               Jid from,
               String name,
               String description,
               String id,
               Integer size,
               Boolean restrict,
               Collection<Catalog.Item> items)

Method Detail

getTo

public final Jid getTo()

Gets the 'to' attribute.

Returns:

The 'to' attribute.

getFrom

public final Jid getFrom()

Gets the 'from' attribute.

Returns:

The 'from' attribute.

getName

public final String getName()

Gets the catalog name.

Returns:

The catalog name.

getDescription

public final String getDescription()

Gets the description.

Returns:

The description.

getId

public final String getId()

Identifier for current revision, commonly a hash.

Returns:

The id.

isRestrictive

public final boolean isRestrictive()

If catalog is restrictive, the client SHOULD restrict the user to choosing one of the items from the catalog and use the label of that item (or no label if the selected item is empty).

Returns:

True, if restrictive.

getSize

public final Integer getSize()

Gets the number of items.

Returns:

The number of items.

getItems

public final List<Catalog.Item> getItems()

Gets the catalog items.

Returns:

The catalog items.