PrivacyRule (Babbler 0.5.1)

java.lang.Object
- rocks.xmpp.extensions.privacy.model.PrivacyRule

All Implemented Interfaces:

Comparable<PrivacyRule>
```
public final class PrivacyRule
extends Object
implements Comparable<PrivacyRule>
```
A privacy rule for privacy lists, which is applied by the server.
2.2 Business Rules
- The order in which privacy list items are processed by the server is important. List items MUST be processed in ascending order determined by the integer values of the 'order' attribute for each <item/>.
- As soon as a stanza is matched against a privacy list rule, the server MUST appropriately handle the stanza in accordance with the rule and cease processing.
- If no fall-through item is provided in a list, the fall-through action is assumed to be "allow".
This class is immutable.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PrivacyRule.Action` Defines the action to perform with the privacy item: either allow or deny communication.
`static class`	`PrivacyRule.Type` Defines the type of communication which should be allowed of denied.

Constructor Summary

Constructors
Constructor and Description
`PrivacyRule(PrivacyRule.Action action, long order)` Creates a privacy list item, which allows or blocks everything.
`PrivacyRule(PrivacyRule.Action action, long order, Contact.Subscription subscription)` Creates a privacy rule of type 'subscription'.
`PrivacyRule(PrivacyRule.Action action, long order, Jid jid)` Creates a privacy rule of type 'jid'.
`PrivacyRule(PrivacyRule.Action action, long order, String group)` Creates a privacy rule of type 'group'.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(PrivacyRule o)` Compares this rule with another rule by comparing their order.
`PrivacyRule`	`filterIQ()` Creates a privacy rule, which filters IQ stanzas.
`PrivacyRule`	`filterMessage()` Creates a privacy rule, which filters message stanzas.
`PrivacyRule`	`filterPresenceIn()` Creates a privacy rule, which filters inbound presence stanzas.
`PrivacyRule`	`filterPresenceOut()` Creates a privacy rule, which filters outbound presence stanzas.
`PrivacyRule.Action`	`getAction()` Sets the action to perform (either allow or deny).
`long`	`getOrder()` Gets the order in which privacy items are processed by the server.
`PrivacyRule.Type`	`getType()` Gets the type.
`String`	`getValue()` Gets the value.
`boolean`	`isFilterIQ()` Indicates, whether inbound IQ stanzas are filtered.
`boolean`	`isFilterMessage()` Indicates, whether inbound message stanzas are filtered.
`boolean`	`isFilterPresenceIn()` Indicates, whether inbound presence notifications are filtered.
`boolean`	`isFilterPresenceOut()` Indicates, whether outbound presence notifications are filtered.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PrivacyRule
```
public PrivacyRule(PrivacyRule.Action action,
           long order)
```
    Creates a privacy list item, which allows or blocks everything.
    
    Parameters:
    action - The action to perform, i.e. either allow or deny.
    order - The order in which the privacy item is processed by the server. A non-negative integer that is unique among all items in the list.
  - PrivacyRule
```
public PrivacyRule(PrivacyRule.Action action,
           long order,
           Contact.Subscription subscription)
```
    Creates a privacy rule of type 'subscription'.
    
    Parameters:
    action - The action to perform, i.e. either allow or deny.
    order - The order in which the privacy item is processed by the server. A non-negative integer that is unique among all items in the list.
    subscription - The subscription.
  - PrivacyRule
```
public PrivacyRule(PrivacyRule.Action action,
           long order,
           Jid jid)
```
    Creates a privacy rule of type 'jid'.
    
    Parameters:
    action - The action to perform, i.e. either allow or deny.
    order - The order in which the privacy item is processed by the server. A non-negative integer that is unique among all items in the list.
    jid - The JID.
  - PrivacyRule
```
public PrivacyRule(PrivacyRule.Action action,
           long order,
           String group)
```
    Creates a privacy rule of type 'group'.
    
    Parameters:
    action - The action to perform, i.e. either allow or deny.
    order - The order in which the privacy item is processed by the server. A non-negative integer that is unique among all items in the list.
    group - The contact group.
- Method Detail
  - getType
```
public final PrivacyRule.Type getType()
```
    Gets the type.
    
    Returns:
    The type.
  - getAction
```
public final PrivacyRule.Action getAction()
```
    Sets the action to perform (either allow or deny).
    
    Returns:
    The action.
  - getValue
```
public final String getValue()
```
    Gets the value.
    
    Returns:
    The value.
  - getOrder
```
public final long getOrder()
```
    Gets the order in which privacy items are processed by the server.
    
    Returns:
    The order.
  - isFilterMessage
```
public final boolean isFilterMessage()
```
    Indicates, whether inbound message stanzas are filtered.
    
    Returns:
    True, if inbound message stanzas are filtered.
  - filterMessage
```
public final PrivacyRule filterMessage()
```
    Creates a privacy rule, which filters message stanzas.
    
    Returns:
    The privacy rule.
    See Also:
    isFilterMessage()
  - isFilterIQ
```
public final boolean isFilterIQ()
```
    Indicates, whether inbound IQ stanzas are filtered.
    
    Returns:
    True, if inbound IQ stanzas are filtered.
  - filterIQ
```
public final PrivacyRule filterIQ()
```
    Creates a privacy rule, which filters IQ stanzas.
    
    Returns:
    The privacy rule.
    See Also:
    isFilterIQ()
  - isFilterPresenceIn
```
public final boolean isFilterPresenceIn()
```
    Indicates, whether inbound presence notifications are filtered.
    
    Returns:
    True, if inbound presence notifications are filtered.
  - filterPresenceIn
```
public final PrivacyRule filterPresenceIn()
```
    Creates a privacy rule, which filters inbound presence stanzas.
    
    Returns:
    The privacy rule.
    See Also:
    isFilterPresenceIn()
  - isFilterPresenceOut
```
public final boolean isFilterPresenceOut()
```
    Indicates, whether outbound presence notifications are filtered.
    
    Returns:
    True, if outbound presence notifications are filtered.
  - filterPresenceOut
```
public final PrivacyRule filterPresenceOut()
```
    Creates a privacy rule, which filters outbound presence stanzas.
    
    Returns:
    The privacy rule.
    See Also:
    isFilterPresenceOut()
  - compareTo
```
public final int compareTo(PrivacyRule o)
```
    Compares this rule with another rule by comparing their order.
    
    Specified by:
    
    compareTo in interface Comparable<PrivacyRule>
    
    Parameters:
    o - The other rule.
    
    Returns:
    The comparison result.
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object

Class PrivacyRule

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PrivacyRule

PrivacyRule

PrivacyRule

PrivacyRule

Method Detail

getType

getAction

getValue

getOrder

isFilterMessage

filterMessage

isFilterIQ

filterIQ

isFilterPresenceIn

filterPresenceIn

isFilterPresenceOut

filterPresenceOut

compareTo

toString