com::wombat::mama::MamaSubscriptionState

Public Functions

	Name
int	getValue()
String	toString()
MamaSubscriptionState	getSubscriptionState(int state)
MamaSubscriptionState	parseSubscriptionState(String state)
String	toString(int state)
String	toString(MamaSubscriptionState state)

Public Attributes

	Name
final MamaSubscriptionState	MAMA_SUBSCRIPTION_UNKNOWN
final MamaSubscriptionState	MAMA_SUBSCRIPTION_ALLOCATED
final MamaSubscriptionState	MAMA_SUBSCRIPTION_SETUP
final MamaSubscriptionState	MAMA_SUBSCRIPTION_ACTIVATING
final MamaSubscriptionState	MAMA_SUBSCRIPTION_ACTIVATED
final MamaSubscriptionState	MAMA_SUBSCRIPTION_DEACTIVATING
final MamaSubscriptionState	MAMA_SUBSCRIPTION_DEACTIVATED
final MamaSubscriptionState	MAMA_SUBSCRIPTION_DESTROYING
final MamaSubscriptionState	MAMA_SUBSCRIPTION_DESTROYED
final MamaSubscriptionState	MAMA_SUBSCRIPTION_DEALLOCATING
final MamaSubscriptionState	MAMA_SUBSCRIPTION_DEALLOCATED
final MamaSubscriptionState	MAMA_SUBSCRIPTION_REACTIVATING

Detailed Description

class com::wombat::mama::MamaSubscriptionState;

This class is the java equivalent of the C subscription state enumeration.

Public Functions Documentation

function getValue

inline int getValue()

Return: The state as an integer.

Returns the integer representation of the subscription state.

function toString

inline String toString()

Return: The string representation.

This function returns the string representation of the member state.

function getSubscriptionState

static inline MamaSubscriptionState getSubscriptionState(
    int state
)

Parameters:

state The state.

Return: To return the MamaSusbscriptionState instance.

This function converts the integer state value to a corresponding MamaSubscriptionState object.

function parseSubscriptionState

static inline MamaSubscriptionState parseSubscriptionState(
    String state
)

Parameters:

state

Return: The corresponding state object or MAMA_SUBSCRIPTION_UNKNOWN if the string isn’t recognised.

This function will return the subscription state corresponding to the supplied string. Note that if the string is not recognised then MAMA_SUBSCRIPTION_UNKNOWN will be returned.

function toString

static inline String toString(
    int state
)

Parameters:

state The state.

Return: The string representation.

This function returns the string representation of the state.

function toString

static inline String toString(
    MamaSubscriptionState state
)

Parameters:

state The state.

Return: The string representation.

This function returns the string representation of the state.

Public Attributes Documentation

variable MAMA_SUBSCRIPTION_UNKNOWN

static final MamaSubscriptionState MAMA_SUBSCRIPTION_UNKNOWN = new MamaSubscriptionState(0);

variable MAMA_SUBSCRIPTION_ALLOCATED

static final MamaSubscriptionState MAMA_SUBSCRIPTION_ALLOCATED = new MamaSubscriptionState(1);

variable MAMA_SUBSCRIPTION_SETUP

static final MamaSubscriptionState MAMA_SUBSCRIPTION_SETUP = new MamaSubscriptionState(2);

variable MAMA_SUBSCRIPTION_ACTIVATING

static final MamaSubscriptionState MAMA_SUBSCRIPTION_ACTIVATING = new MamaSubscriptionState(3);

variable MAMA_SUBSCRIPTION_ACTIVATED

static final MamaSubscriptionState MAMA_SUBSCRIPTION_ACTIVATED = new MamaSubscriptionState(4);

variable MAMA_SUBSCRIPTION_DEACTIVATING

static final MamaSubscriptionState MAMA_SUBSCRIPTION_DEACTIVATING = new MamaSubscriptionState(5);

variable MAMA_SUBSCRIPTION_DEACTIVATED

static final MamaSubscriptionState MAMA_SUBSCRIPTION_DEACTIVATED = new MamaSubscriptionState(6);

variable MAMA_SUBSCRIPTION_DESTROYING

static final MamaSubscriptionState MAMA_SUBSCRIPTION_DESTROYING = new MamaSubscriptionState(7);

variable MAMA_SUBSCRIPTION_DESTROYED

static final MamaSubscriptionState MAMA_SUBSCRIPTION_DESTROYED = new MamaSubscriptionState(8);

variable MAMA_SUBSCRIPTION_DEALLOCATING

static final MamaSubscriptionState MAMA_SUBSCRIPTION_DEALLOCATING = new MamaSubscriptionState(9);

variable MAMA_SUBSCRIPTION_DEALLOCATED

static final MamaSubscriptionState MAMA_SUBSCRIPTION_DEALLOCATED = new MamaSubscriptionState(10);

variable MAMA_SUBSCRIPTION_REACTIVATING

static final MamaSubscriptionState MAMA_SUBSCRIPTION_REACTIVATING = new MamaSubscriptionState(11);

Updated on 2023-03-31 at 15:29:44 +0100