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

Class Catalog.Item

java.lang.Object

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

Enclosing class:

Catalog

public static final class Catalog.Item
extends Object

A catalog item.

An item may have no security label. Such an item explicitly offers a choice of sending a stanza without a label. A non-restrictive catalog implicitly offers this choice when it does not contain an empty item.

Constructor Summary

Constructors

Constructor	Description
Item()
Item(String selector, SecurityLabel securityLabel, Boolean isDefault)

Method Summary

Modifier and Type	Method	Description
SecurityLabel	getSecurityLabel()	Gets the security label or null.
String	getSelector()	Gets the selector.
boolean	isDefault()	Whether this item is the default item.

Methods inherited from class java.lang.Object

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

Constructor Detail

Item

public Item()

Item

public Item(String selector,
            SecurityLabel securityLabel,
            Boolean isDefault)

Method Detail

getSecurityLabel

public final SecurityLabel getSecurityLabel()

Gets the security label or null.

Returns:

The security label or null.

getSelector

public final String getSelector()

Gets the selector.

Items in the catalog may contain a selector= attribute. The value of this attribute represents the item's placement in a hierarchical organization of the items. If one item has a selector= attribute, all items should have a selector= attribute. The value of the selector= attribute conforms to the selector-value ABNF production:

selector-value = (<item>"|")*<item>

where <item/> is a sequence of characters not including "|".

A value of "X|Y|Z" indicates that this item is "Z" in the the "Y" subset of the "X" subset of items. This information may be used, for instance, in generating label selection menus in graphical user interfaces.

Returns:

The selector.

isDefault

public final boolean isDefault()

Whether this item is the default item.

The client should default the label selection to this item in cases where the user has not selected an item.

Returns:

If this item is the default.