javax.slee.AddressScreening Maven / Gradle / Ivy
package javax.slee;
import java.io.Serializable;
import java.io.StreamCorruptedException;
/**
* 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 {@link java.io.Serializable 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.)
* @see Address
*/
public final class AddressScreening implements Serializable{
/**
* An integer representation of {@link #UNDEFINED}.
*/
public static final int ADDRESS_SCREENING_UNDEFINED = 0;
/**
* An integer representation of {@link #USER_NOT_VERIFIED}.
*/
public static final int ADDRESS_SCREENING_USER_NOT_VERIFIED = 1;
/**
* An integer representation of {@link #USER_VERIFIED_PASSED}.
*/
public static final int ADDRESS_SCREENING_USER_VERIFIED_PASSED = 2;
/**
* An integer representation of {@link #USER_VERIFIED_FAILED}.
*/
public static final int ADDRESS_SCREENING_USER_VERIFIED_FAILED = 3;
/**
* An integer representation of {@link #NETWORK}.
*/
public static final int ADDRESS_SCREENING_NETWORK = 4;
/**
* A string representation of {@link #UNDEFINED}.
*/
public static final String UNDEFINED_STRING = "Undefined";
/**
* A string representation of {@link #USER_NOT_VERIFIED}.
*/
public static final String USER_NOT_VERIFIED_STRING = "Not Verified";
/**
* A string representation of {@link #USER_VERIFIED_PASSED}.
*/
public static final String USER_VERIFIED_PASSED_STRING = "User Verified Passed";
/**
* A string representation of {@link #USER_VERIFIED_FAILED}.
*/
public static final String USER_VERIFIED_FAILED_STRING = "User Verified Failed";
/**
* A string representation of {@link #NETWORK}.
*/
public static final String NETWORK_STRING = "Network";
/**
* The UNDEFINED value indicates that the address screening
* is undefined.
*/
public static final AddressScreening UNDEFINED = new AddressScreening(ADDRESS_SCREENING_UNDEFINED);
/**
* The USER_NOT_VERIFIED value indicates that the user-provided
* address has not been verified.
*/
public static final AddressScreening USER_NOT_VERIFIED = new AddressScreening(ADDRESS_SCREENING_USER_NOT_VERIFIED);
/**
* The USER_VERIFIED_PASSED value indicates that the user-provided
* address has been verified and passed.
*/
public static final AddressScreening USER_VERIFIED_PASSED = new AddressScreening(ADDRESS_SCREENING_USER_VERIFIED_PASSED);
/**
* The USER_VERIFIED_FAILED value indicates that the user-provider
* address has been verified but failed.
*/
public static final AddressScreening USER_VERIFIED_FAILED = new AddressScreening(ADDRESS_SCREENING_USER_VERIFIED_FAILED);
/**
* The NETWORK value indicates that the address is a
* network or application provided address.
*/
public static final AddressScreening NETWORK = new AddressScreening(ADDRESS_SCREENING_NETWORK);
/**
* Get an AddressScreening object from an integer value.
* @param value the address screening value as an integer.
* @return an AddressScreening object corresponding to value.
* @throws IllegalArgumentException if value is not a valid
* address screening value.
*/
public static AddressScreening fromInt(int value) throws IllegalArgumentException {
switch (value) {
case ADDRESS_SCREENING_UNDEFINED: return UNDEFINED;
case ADDRESS_SCREENING_USER_NOT_VERIFIED: return USER_NOT_VERIFIED;
case ADDRESS_SCREENING_USER_VERIFIED_PASSED: return USER_VERIFIED_PASSED;
case ADDRESS_SCREENING_USER_VERIFIED_FAILED: return USER_VERIFIED_FAILED;
case ADDRESS_SCREENING_NETWORK: return NETWORK;
default: throw new IllegalArgumentException("Invalid value: " + value);
}
}
/**
* Get an AddressScreening object from a string value.
* @param value the address screening as a string, for example as returned by the
{@link #toString()} method (case insensitive).
* @return an AddressScreening object corresponding to value.
* @throws NullPointerException if value is null.
* @throws IllegalArgumentException if value is not a valid
* address screening value.
* @since SLEE 1.1
*/
public AddressScreening fromString(String value) throws NullPointerException, IllegalArgumentException {
if (value == null) throw new NullPointerException("value is null");
if (value.equalsIgnoreCase(UNDEFINED_STRING)) return UNDEFINED;
if (value.equalsIgnoreCase(USER_NOT_VERIFIED_STRING)) return USER_NOT_VERIFIED;
if (value.equalsIgnoreCase(USER_VERIFIED_PASSED_STRING)) return USER_VERIFIED_PASSED;
if (value.equalsIgnoreCase(USER_VERIFIED_FAILED_STRING)) return USER_VERIFIED_FAILED;
if (value.equalsIgnoreCase(NETWORK_STRING)) return NETWORK;
throw new IllegalArgumentException("Invalid value: " + value);
}
/**
* Get an integer value representation for this AddressScreening object.
* @return an integer value representation for this AddressScreening object.
*/
public int toInt() {
return value;
}
/**
* Determine if this AddressScreening object represents the UNDEFINED address
* screening value.
*
* 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) ...
*
* @return true if this object represents the UNDEFINED address screening
* value, false otherwise.
*/
public boolean isUndefined() {
return value == ADDRESS_SCREENING_UNDEFINED;
}
/**
* Determine if this AddressScreening object represents the USER_NOT_VERIFIED address
* screening value.
*
* 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) ...
*
* @return true if this object represents the USER_NOT_VERIFIED address screening
* value, false otherwise.
*/
public boolean isUserNotVerified() {
return value == ADDRESS_SCREENING_USER_NOT_VERIFIED;
}
/**
* Determine if this AddressScreening object represents the USER_VERIFIED_PASSED address
* screening value.
*
* 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) ...
*
* @return true if this object represents the USER_VERIFIED_PASSED address screening
* value, false otherwise.
*/
public boolean isUserVerifiedPassed() {
return value == ADDRESS_SCREENING_USER_VERIFIED_PASSED;
}
/**
* Determine if this AddressScreening object represents the USER_VERIFIED_FAILED address
* screening value.
*
* 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) ...
*
* @return true if this object represents the USER_VERIFIED_FAILED address screening
* value, false otherwise.
*/
public boolean isUserVerifiedFailed() {
return value == ADDRESS_SCREENING_USER_VERIFIED_FAILED;
}
/**
* Determine if this AddressScreening object represents the NETWORK address
* screening value.
*
* 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) ...
*
* @return true if this object represents the NETWORK address screening
* value, false otherwise.
*/
public boolean isNetwork() {
return value == ADDRESS_SCREENING_NETWORK;
}
/**
* Compare this address screening for equality with another.
* @param obj the object to compare this with.
* @return true if obj is an instance of this class
* representing the same address screening value as this,
* false otherwise.
*/
public boolean equals(Object obj) {
if (obj == this) return true;
return (obj instanceof AddressScreening)
&& ((AddressScreening)obj).value == value;
}
/**
* Get a hash code value for this address screening.
* @return a hash code value.
*/
public int hashCode() {
return value;
}
/**
* Get the textual representation of the address screening object.
* @return the textual representation of the address screening object.
*/
public String toString() {
switch (value) {
case ADDRESS_SCREENING_UNDEFINED: return UNDEFINED_STRING;
case ADDRESS_SCREENING_USER_NOT_VERIFIED: return USER_NOT_VERIFIED_STRING;
case ADDRESS_SCREENING_USER_VERIFIED_PASSED: return USER_VERIFIED_PASSED_STRING;
case ADDRESS_SCREENING_USER_VERIFIED_FAILED: return USER_VERIFIED_FAILED_STRING;
case ADDRESS_SCREENING_NETWORK: return NETWORK_STRING;
default: return "Address Screening in Unknown and Invalid State";
}
}
/**
* Private constructor to prevent unauthorized object creation.
*/
private AddressScreening(int value) {
this.value = value;
}
/**
* Resolve deserialisation references so that the singleton property of each
* enumerated object is preserved.
*/
private Object readResolve() throws StreamCorruptedException {
try {
return fromInt(value);
}
catch (IllegalArgumentException iae) {
throw new StreamCorruptedException("Invalid internal state found");
}
}
private final int value;
}