net.rim.device.api.smartcard
Class SmartCardID

java.lang.Object
  net.rim.device.api.smartcard.SmartCardID

All Implemented Interfaces:

Persistable

public final class SmartCardID
extends Object
implements Persistable

A class to represent a specific smart card within a family of smart cards.

See Also:

SmartCard

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

Constructor Summary
	SmartCardID(long id, String label, SmartCard smartCard) Constructs a SmartCardID object.
	SmartCardID(long id, String label, SmartCard smartCard, String readerName) Constructs a SmartCardID object.

Method Summary
	boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
	long	getID() Returns the unique identifier.
	String	getLabel() Returns a human readable String that identifies this specific smart card to the user.
	SmartCard	getSmartCard() Returns the family of smart cards that this specific card is a member of.
	String	getSmartCardReaderName() Returns the name of the smart card reader used to read this specific card.
	int	hashCode() Returns a hash code value for the object.
	void	setSmartCardReaderName(String readerName) Sets the name of the smart card reader used to read this specific card.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SmartCardID

public SmartCardID(long id,
                   String label,
                   SmartCard smartCard)

Constructs a SmartCardID object.

Parameters:

id - A unique number identifying a particular smart card. For example a personel number.

label - A human readable String that identifies this specific smart card to the user. For example, the type of card and name of the card holder, "Visa: Michael Adams".

smartCard - The class of smart cards that this specific card is a instance of.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

SmartCardID

public SmartCardID(long id,
                   String label,
                   SmartCard smartCard,
                   String readerName)

Constructs a SmartCardID object.

Parameters:

id - A unique number identifying a particular smart card. For example a personel number.

label - A human readable String that identifies this specific smart card to the user. For example, the type of card and name of the card holder, "Visa: Michael Adams".

smartCard - The class of smart cards that this specific card is a instance of.

reader - The name of the reader used to read this specific card.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

Method Detail

getID

public long getID()

Returns the unique identifier.

Returns:

A long representing the ID.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

getLabel

public String getLabel()

Returns a human readable String that identifies this specific smart card to the user.

Returns:

A String representing the label.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

getSmartCard

public SmartCard getSmartCard()

Returns the family of smart cards that this specific card is a member of.

Returns:

A SmartCard.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

getSmartCardReaderName

public String getSmartCardReaderName()

Returns the name of the smart card reader used to read this specific card.

Returns:

A SmartCardReader.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

setSmartCardReaderName

public void setSmartCardReaderName(String readerName)

Sets the name of the smart card reader used to read this specific card.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

equals

public boolean equals(Object obj)

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation:

• It is reflexive: for any reference value x, x.equals(x) should return true.
• It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Boolean.hashCode(), Hashtable

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0