org.asteriskjava.pbx.internal.asterisk

Class CallerIDImpl

java.lang.Object

org.asteriskjava.pbx.internal.asterisk.CallerIDImpl

All Implemented Interfaces:

CallerID

public class CallerIDImpl
extends Object
implements CallerID

Constructor Summary

Constructors

Constructor and Description
CallerIDImpl(String number, String name) Creates a caller ID.

Method Summary

Modifier and Type	Method and Description
static CallerID	buildFromComponents(String firstname, String lastname, String number) This is a little helper class which will buid the name component of a clid from the first and lastnames.
String	formatted() Formats and returns the caller ID in an asterisk specific format suitable for passing to the likes of the originate action.
String	getName() Gets the name component of the caller id.
String	getNumber() Gets the number component of the caller id.
boolean	isHideCallerID()
boolean	isUnknown() Returns true if the caller id number is blank or equal to 'unknown'.
void	setHideCallerID(boolean hide) Controls whether this caller id should be presented to the remote end.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CallerIDImpl

public CallerIDImpl(String number,
                    String name)

Creates a caller ID.

Parameters:

number - - if null then we store an empty string.

name - - if null then we store an empty string.

Method Detail

getNumber

public String getNumber()

Description copied from interface: CallerID

Gets the number component of the caller id.

Specified by:

getNumber in interface CallerID

Returns:

the callerid's number

getName

public String getName()

Description copied from interface: CallerID

Gets the name component of the caller id.

Specified by:

getName in interface CallerID

Returns:

the callerid's name

buildFromComponents

public static CallerID buildFromComponents(String firstname,
                                           String lastname,
                                           String number)

This is a little helper class which will buid the name component of a clid from the first and lastnames. If both firstname and lastname are null then the name component will be an empty string.

Parameters:

firstname - the person's firstname, may be null.

lastname - the person's lastname, may be null

number - the phone number.

Returns:

formatted

public String formatted()

Formats and returns the caller ID in an asterisk specific format suitable for passing to the likes of the originate action. The format is: name

Returns:

a formatted clid.

setHideCallerID

public void setHideCallerID(boolean hide)

Description copied from interface: CallerID

Controls whether this caller id should be presented to the remote end.

Specified by:

setHideCallerID in interface CallerID

Parameters:

hide - - if true then the caller id will be hidden.

isHideCallerID

public boolean isHideCallerID()

Specified by:

isHideCallerID in interface CallerID

Returns:

true if the caller id is marked as hidden.

toString

public String toString()

Overrides:

toString in class Object

isUnknown

public boolean isUnknown()

Description copied from interface: CallerID

Returns true if the caller id number is blank or equal to 'unknown'.

Specified by:

isUnknown in interface CallerID

Returns: