public final class AddressScreening extends Object implements Serializable
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 FormModifier and Type | Field and Description |
---|---|
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 String |
NETWORK_STRING
A string representation of
NETWORK . |
static AddressScreening |
UNDEFINED
The UNDEFINED value indicates that the address screening
is undefined.
|
static String |
UNDEFINED_STRING
A string representation of
UNDEFINED . |
static AddressScreening |
USER_NOT_VERIFIED
The USER_NOT_VERIFIED value indicates that the user-provided
address has not been verified.
|
static String |
USER_NOT_VERIFIED_STRING
A string representation of
USER_NOT_VERIFIED . |
static AddressScreening |
USER_VERIFIED_FAILED
The USER_VERIFIED_FAILED value indicates that the user-provider
address has been verified but failed.
|
static String |
USER_VERIFIED_FAILED_STRING
A string representation of
USER_VERIFIED_FAILED . |
static AddressScreening |
USER_VERIFIED_PASSED
The USER_VERIFIED_PASSED value indicates that the user-provided
address has been verified and passed.
|
static String |
USER_VERIFIED_PASSED_STRING
A string representation of
USER_VERIFIED_PASSED . |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
Compare this address screening for equality with another.
|
static AddressScreening |
fromInt(int value)
Get an
AddressScreening object from an integer value. |
AddressScreening |
fromString(String value)
Get an
AddressScreening object from a string 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. |
String |
toString()
Get the textual representation of the address screening object.
|
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 String UNDEFINED_STRING
UNDEFINED
.public static final String USER_NOT_VERIFIED_STRING
USER_NOT_VERIFIED
.public static final String USER_VERIFIED_PASSED_STRING
USER_VERIFIED_PASSED
.public static final String USER_VERIFIED_FAILED_STRING
USER_VERIFIED_FAILED
.public static final String NETWORK_STRING
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
public static AddressScreening fromInt(int value) throws IllegalArgumentException
AddressScreening
object from an integer value.value
- the address screening value as an integer.AddressScreening
object corresponding to value
.IllegalArgumentException
- if value
is not a valid
address screening value.public AddressScreening fromString(String value) throws NullPointerException, IllegalArgumentException
AddressScreening
object from a string value.value
- the address screening as a string, for example as returned by the
toString()
method (case insensitive).AddressScreening
object corresponding to value
.NullPointerException
- if value
is null
.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(Object obj)
public int hashCode()