All Superinterfaces:: Cloneable, javax.sip.header.Header, Serializable

public interface PrivacyHeader
extends javax.sip.header.Header

RFC 3323 Privacy header.

 Privacy-hdr  =  "Privacy" HCOLON priv-value *(";" priv-value)
   priv-value   =   "header" / "session" / "user" / "none" / "critical"
                    / token

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`NAME`
`static String`	`PRIVACY_CRITICAL`
`static String`	`PRIVACY_HEADER`
`static String`	`PRIVACY_ID`
`static String`	`PRIVACY_NONE`
`static String`	`PRIVACY_SESSION`
`static String`	`PRIVACY_USER`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addPrivacyValue(String value)`	Add another privacy value to the header.
`Iterator`	`getPrivacyValues()`	Convenience method to get all the privacy values currently set in this header.
`boolean`	`isCriticalPrivacyRequested()`	Determine if privacy value "critical" has been requested.
`boolean`	`isHeaderPrivacyRequested()`	Determine if privacy value "header" has been requested.
`boolean`	`isIDPrivacyRequested()`	Determine if privacy value "id" has been requested (RFC 3325).
`boolean`	`isNoPrivacyRequested()`	Determine if privacy value "none" has been requested.
`boolean`	`isPrivacyRequested(String value)`	Determine if the particular privacy value has been requested.
`boolean`	`isSessionPrivacyRequested()`	Determine if privacy value "session" has been requested.
`boolean`	`isUserPrivacyRequested()`	Determine if privacy value "user" has been requested.
`void`	`removePrivacyValue(String value)`	Remove the privacy value from the header.
`void`	`setPrivacyValue(String value)`	Reset the privacy value to a new value, erasing all current values

Methods inherited from interface javax.sip.header.Header
clone, equals, getName, hashCode, toString

- Field Detail
  - NAME
```
static final String NAME
```
    See Also:
    
    Constant Field Values
  - PRIVACY_NONE
```
static final String PRIVACY_NONE
```
    See Also:
    
    Constant Field Values
  - PRIVACY_HEADER
```
static final String PRIVACY_HEADER
```
    See Also:
    
    Constant Field Values
  - PRIVACY_SESSION
```
static final String PRIVACY_SESSION
```
    See Also:
    
    Constant Field Values
  - PRIVACY_USER
```
static final String PRIVACY_USER
```
    See Also:
    
    Constant Field Values
  - PRIVACY_CRITICAL
```
static final String PRIVACY_CRITICAL
```
    See Also:
    
    Constant Field Values
  - PRIVACY_ID
```
static final String PRIVACY_ID
```
    See Also:
    
    Constant Field Values
- Method Detail
  - isNoPrivacyRequested
```
boolean isNoPrivacyRequested()
```
    Determine if privacy value "none" has been requested.
  - isHeaderPrivacyRequested
```
boolean isHeaderPrivacyRequested()
```
    Determine if privacy value "header" has been requested.
  - isSessionPrivacyRequested
```
boolean isSessionPrivacyRequested()
```
    Determine if privacy value "session" has been requested.
  - isUserPrivacyRequested
```
boolean isUserPrivacyRequested()
```
    Determine if privacy value "user" has been requested.
  - isCriticalPrivacyRequested
```
boolean isCriticalPrivacyRequested()
```
    Determine if privacy value "critical" has been requested.
  - isIDPrivacyRequested
```
boolean isIDPrivacyRequested()
```
    Determine if privacy value "id" has been requested (RFC 3325).
  - isPrivacyRequested
```
boolean isPrivacyRequested(String value)
```
    Determine if the particular privacy value has been requested.
    
    Returns:
    
    true if the value has been set in the header, false otherwise.
  - setPrivacyValue
```
void setPrivacyValue(String value)
```
    Reset the privacy value to a new value, erasing all current values
  - addPrivacyValue
```
void addPrivacyValue(String value)
```
    Add another privacy value to the header. If the current privacy value is "none", this method throws an IllegalArgumentException
  - removePrivacyValue
```
void removePrivacyValue(String value)
```
    Remove the privacy value from the header. If the value is not present, the method returns silently.
  - getPrivacyValues
```
Iterator getPrivacyValues()
```
    Convenience method to get all the privacy values currently set in this header.
    
    Returns:
    
    an immutable Iterator of Strings.

Interface PrivacyHeader

Field Summary

Method Summary

Methods inherited from interface javax.sip.header.Header

Field Detail

NAME

PRIVACY_NONE

PRIVACY_HEADER

PRIVACY_SESSION

PRIVACY_USER

PRIVACY_CRITICAL

PRIVACY_ID

Method Detail

isNoPrivacyRequested

isHeaderPrivacyRequested

isSessionPrivacyRequested

isUserPrivacyRequested

isCriticalPrivacyRequested

isIDPrivacyRequested

isPrivacyRequested

setPrivacyValue

addPrivacyValue

removePrivacyValue

getPrivacyValues