|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.slee.AddressScreening
This class defines an enumerated type that encapsulates the values defining whether an address has been screened by a user application. The application can choose one of these constants depending on whether it has screened the address and the outcome received.
A singleton instance of each enumerated value is guaranteed (via an implementation
of readResolve()
- refer java.io.Serializable
),
so that equality tests using ==
are always evaluated correctly. (This
equality test is only guaranteed if this class is loaded in the application's boot class
path, rather than dynamically loaded at runtime.)
Address
, Serialized FormField Summary | |
static int |
ADDRESS_SCREENING_NETWORK
An integer representation of NETWORK . |
static int |
ADDRESS_SCREENING_UNDEFINED
An integer representation of UNDEFINED . |
static int |
ADDRESS_SCREENING_USER_NOT_VERIFIED
An integer representation of USER_NOT_VERIFIED . |
static int |
ADDRESS_SCREENING_USER_VERIFIED_FAILED
An integer representation of USER_VERIFIED_FAILED . |
static int |
ADDRESS_SCREENING_USER_VERIFIED_PASSED
An integer representation of USER_VERIFIED_PASSED . |
static AddressScreening |
NETWORK
The NETWORK value indicates that the address is a network or application provided address. |
static AddressScreening |
UNDEFINED
The UNDEFINED value indicates that the address screening is undefined. |
static AddressScreening |
USER_NOT_VERIFIED
The USER_NOT_VERIFIED value indicates that the user-provided address has not been verified. |
static AddressScreening |
USER_VERIFIED_FAILED
The USER_VERIFIED_FAILED value indicates that the user-provider address has been verified but failed. |
static AddressScreening |
USER_VERIFIED_PASSED
The USER_VERIFIED_PASSED value indicates that the user-provided address has been verified and passed. |
Method Summary | |
boolean |
equals(java.lang.Object obj)
Compare this address screening for equality with another. |
static AddressScreening |
fromInt(int value)
Get an AddressScreening object from an integer value. |
int |
hashCode()
Get a hash code value for this address screening. |
boolean |
isNetwork()
Determine if this AddressScreening object represents the NETWORK address screening value. |
boolean |
isUndefined()
Determine if this AddressScreening object represents the UNDEFINED address screening value. |
boolean |
isUserNotVerified()
Determine if this AddressScreening object represents the USER_NOT_VERIFIED address screening value. |
boolean |
isUserVerifiedFailed()
Determine if this AddressScreening object represents the USER_VERIFIED_FAILED address screening value. |
boolean |
isUserVerifiedPassed()
Determine if this AddressScreening object represents the USER_VERIFIED_PASSED address screening value. |
int |
toInt()
Get an integer value representation for this AddressScreening object. |
java.lang.String |
toString()
Get the textual representation of the address screening object. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int ADDRESS_SCREENING_UNDEFINED
UNDEFINED
.public static final int ADDRESS_SCREENING_USER_NOT_VERIFIED
USER_NOT_VERIFIED
.public static final int ADDRESS_SCREENING_USER_VERIFIED_PASSED
USER_VERIFIED_PASSED
.public static final int ADDRESS_SCREENING_USER_VERIFIED_FAILED
USER_VERIFIED_FAILED
.public static final int ADDRESS_SCREENING_NETWORK
NETWORK
.public static final AddressScreening UNDEFINED
public static final AddressScreening USER_NOT_VERIFIED
public static final AddressScreening USER_VERIFIED_PASSED
public static final AddressScreening USER_VERIFIED_FAILED
public static final AddressScreening NETWORK
Method Detail |
public static AddressScreening fromInt(int value) throws java.lang.IllegalArgumentException
AddressScreening
object from an integer value.value
- the address screening value as an integer.AddressScreening
object corresponding to value
.java.lang.IllegalArgumentException
- if value
is not a valid
address screening value.public int toInt()
AddressScreening
object.AddressScreening
object.public boolean isUndefined()
This method is effectively equivalent to the conditional test:
(this == UNDEFINED)
, ie. the code:
if (screening.isUndefined()) ...
is interchangeable with the code:
if (screening == AddressScreening.UNDEFINED) ...
true
if this object represents the UNDEFINED address screening
value, false
otherwise.public boolean isUserNotVerified()
This method is effectively equivalent to the conditional test:
(this == USER_NOT_VERIFIED)
, ie. the code:
if (screening.isUserNotVerified()) ...
is interchangeable with the code:
if (screening == AddressScreening.USER_NOT_VERIFIED) ...
true
if this object represents the USER_NOT_VERIFIED address screening
value, false
otherwise.public boolean isUserVerifiedPassed()
This method is effectively equivalent to the conditional test:
(this == USER_VERIFIED_PASSED)
, ie. the code:
if (screening.isUserVerifiedPassed()) ...
is interchangeable with the code:
if (screening == AddressScreening.USER_VERIFIED_PASSED) ...
true
if this object represents the USER_VERIFIED_PASSED address screening
value, false
otherwise.public boolean isUserVerifiedFailed()
This method is effectively equivalent to the conditional test:
(this == USER_VERIFIED_FAILED)
, ie. the code:
if (screening.isUserVerifiedFailed()) ...
is interchangeable with the code:
if (screening == AddressScreening.USER_VERIFIED_FAILED) ...
true
if this object represents the USER_VERIFIED_FAILED address screening
value, false
otherwise.public boolean isNetwork()
This method is effectively equivalent to the conditional test:
(this == NETWORK)
, ie. the code:
if (screening.isNetword()) ...
is interchangeable with the code:
if (screening == AddressScreening.NETWORK) ...
true
if this object represents the NETWORK address screening
value, false
otherwise.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- the object to compare this with.true
if obj
is an instance of this class
representing the same address screening value as this,
false
otherwise.public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |