gov.nist.javax.sip.address

Class UserInfo

java.lang.Object

gov.nist.core.GenericObject

gov.nist.javax.sip.address.NetObject

gov.nist.javax.sip.address.UserInfo

All Implemented Interfaces:

Serializable, Cloneable

public final class UserInfo
extends NetObject

User information part of a URL.

Version:

1.2 $Revision: 1.9 $ $Date: 2010-05-06 14:08:06 $

Author:

M. Ranganathan

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	password password field
static int	TELEPHONE_SUBSCRIBER Constant field
protected String	user user field
static int	USER constant field
protected int	userType userType field

Fields inherited from class gov.nist.javax.sip.address.NetObject

CORE_PACKAGE, GRUU, LR, MADDR, METHOD, NET_PACKAGE, PARSER_PACKAGE, PHONE, SIP, SIPS, TCP, TLS, TRANSPORT, TTL, UDP

Fields inherited from class gov.nist.core.GenericObject

AND, AT, COLON, COMMA, DOT, DOUBLE_QUOTE, EQUALS, GREATER_THAN, HT, immutableClasses, indentation, LESS_THAN, LPAREN, matchExpression, NEWLINE, PERCENT, POUND, QUESTION, QUOTE, RETURN, RPAREN, SEMICOLON, SLASH, SP, STAR, stringRepresentation

Constructor Summary

Constructors

Constructor and Description
UserInfo() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	clearPassword() Clear the password field.
String	encode() Encode the user information as a string.
StringBuilder	encode(StringBuilder buffer) Put the encoded version of this object in the given StringBuilder.
boolean	equals(Object obj) Compare for equality.
String	getPassword() get the password field.
String	getUser() get the user field.
int	getUserType() Gets the user type (which can be set to TELEPHONE_SUBSCRIBER or USER)
void	setPassword(String p) Set the password member
void	setUser(String user) Set the user member
void	setUserType(int type) Set the user type (to TELEPHONE_SUBSCRIBER or USER).

Methods inherited from class gov.nist.javax.sip.address.NetObject

debugDump, debugDump, match, toString

Methods inherited from class gov.nist.core.GenericObject

clone, dbgPrint, dbgPrint, getClassFromName, getIndentation, getMatcher, isMySubclass, makeClone, merge, setMatcher, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

user

protected String user

user field

password

protected String password

password field

userType

protected int userType

userType field

TELEPHONE_SUBSCRIBER

public static final int TELEPHONE_SUBSCRIBER

Constant field

See Also:

Constant Field Values

USER

public static final int USER

constant field

See Also:

Constant Field Values

Constructor Detail

UserInfo

public UserInfo()

Default constructor

Method Detail

equals

public boolean equals(Object obj)

Compare for equality.

Overrides:

equals in class NetObject

Parameters:

obj - Object to set

Returns:

true if the two headers are equals, false otherwise.

encode

public String encode()

Encode the user information as a string.

Specified by:

encode in class GenericObject

Returns:

String

encode

public StringBuilder encode(StringBuilder buffer)

Description copied from class: GenericObject

Put the encoded version of this object in the given StringBuilder.

Overrides:

encode in class GenericObject

clearPassword

public void clearPassword()

Clear the password field.

getUserType

public int getUserType()

Gets the user type (which can be set to TELEPHONE_SUBSCRIBER or USER)

Returns:

the type of user.

getUser

public String getUser()

get the user field.

Returns:

String

getPassword

public String getPassword()

get the password field.

Returns:

String

setUser

public void setUser(String user)

Set the user member

Parameters:

user - String to set

setPassword

public void setPassword(String p)

Set the password member

Parameters:

p - String to set

setUserType

public void setUserType(int type)
                 throws IllegalArgumentException

Set the user type (to TELEPHONE_SUBSCRIBER or USER).

Parameters:

type - int to set

Throws:

IllegalArgumentException - if type is not in range.