java.lang.Object
- com.opencloud.util.AbstractDataObject
- - com.opencloud.util.AbstractFieldsObject
  - - AbstractEncodedDataObject<T>
    - - AbstractLazyEncodedDataObject<T>
      - AbstractLazyEncodedNamedInteger<SMSDataCodingScheme.MessageWaitingScheme.EncodedValue>
        
        com.opencloud.slee.resources.in.datatypes.sms.SMSDataCodingScheme.MessageWaitingScheme

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

SMSDataCodingScheme
```
public static final class SMSDataCodingScheme.MessageWaitingScheme
extends AbstractLazyEncodedNamedInteger<SMSDataCodingScheme.MessageWaitingScheme.EncodedValue>
```
Class MessageWaitingScheme represents the Message Waiting cases of a TP_DCS field.
The API offered by this class is as if the type were specified in ASN.1 as follows.
```
 MessageWaitingScheme ::= SEQUENCE {
     indicationActive BOOLEAN,
     indicationType   IndicationType
 }
```
The class takes care of encoding the field values into a NamedInteger and decoding field values from a NamedInteger, the encoded representation being as tabulated below.

Data Encoding - based on 3GPP TS 23.038 V8.2.0 (2008-09) §4 pp8-10

7 6 5 4 3 2 1 0

Octet 0 0 0 0 0 Indication active? 0 Indication type

Field names ending in ? are booleans: 1 for true, 0 for false.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SMSDataCodingScheme.MessageWaitingScheme.EncodedValue`	Representation of MessageWaitingScheme values as NamedIntegers.
`static class`	`SMSDataCodingScheme.MessageWaitingScheme.IndicationType`	Enumeration of Indication Type constants.

Field Summary
- Fields inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject
  isDecoded
- Fields inherited from class com.opencloud.slee.resources.cgin.AbstractEncodedDataObject
  encoded
- Fields inherited from class com.opencloud.util.AbstractFieldsObject
  FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors
Constructor	Description
`MessageWaitingScheme()`	Constructs a new MessageWaitingScheme object with no fields set.
`MessageWaitingScheme(boolean indicationActive, SMSDataCodingScheme.MessageWaitingScheme.IndicationType indicationType)`	Constructs a new MessageWaitingScheme object from given values for all fields.
`MessageWaitingScheme(byte[] data)`	Constructs a new MessageWaitingScheme object from network-encoded data.
`MessageWaitingScheme(byte[] data, int start, int len)`	Constructs a new MessageWaitingScheme object from part of network-encoded data.
`MessageWaitingScheme(int arg)`	Constructs a new MessageWaitingScheme object from the given int, making it be read-only (immutable).
`MessageWaitingScheme(DataInput in)`	Constructs a new MessageWaitingScheme object from data deserialized from a stream that was written by `toStream(DataOutput)`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`checkFieldsSet()`	Checks that all mandatory fields are present.
`SMSDataCodingScheme.MessageWaitingScheme`	`clone()`	Constructs a copy of this object and everything reachable from it.
`static SMSDataCodingScheme.MessageWaitingScheme`	`copyOf(SMSDataCodingScheme.MessageWaitingScheme from)`	Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.
`protected void`	`decode()`	Computes the decoded form from the encoded form.
`protected void`	`encode()`	Computes the encoded form from the decoded form.
`protected boolean`	`encodedIsInvalid()`	Determines whether the encoded form is invalid.
`protected SMSDataCodingScheme.MessageWaitingScheme.EncodedValue`	`fromValue(int value)`	Converts an int to a NamedInteger.
`byte[]`	`getByteArrayForm()`	Gets the byte array encoded form.
`SMSDataCodingScheme.MessageWaitingScheme.EncodedValue`	`getEncodedForm()`	Gets the encoded form.
`static FieldAccessor[]`	`getFieldAccessors()`	Gets a new array of the accessors for fields of this type.
`Map<String,Object>`	`getFieldsMap(boolean withAbsents)`	Gets a Map from field-name to field-value for the fields of a sequence.
`boolean`	`getIndicationActive()`	Gets the value of whether active.
`SMSDataCodingScheme.MessageWaitingScheme.IndicationType`	`getIndicationType()`	Gets the value of type of message waiting.
`boolean`	`hasIndicationActive()`	Tests whether the field IndicationActive has a value.
`boolean`	`hasIndicationType()`	Tests whether the field IndicationType has a value.
`SMSDataCodingScheme.MessageWaitingScheme`	`setIndicationActive(boolean value)`	Sets the value of whether active.
`SMSDataCodingScheme.MessageWaitingScheme`	`setIndicationActivePresent(boolean flag)`	Sets the presence or absence of the field IndicationActive.
`SMSDataCodingScheme.MessageWaitingScheme`	`setIndicationType(SMSDataCodingScheme.MessageWaitingScheme.IndicationType value)`	Sets the value of type of message waiting.
`void`	`toStream(DataOutput out)`	Serializes this object to a stream in a form suitable for reading by {@link #SMSDataCodingScheme.MessageWaitingScheme(DataInput)}.

Methods inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject
checkDecode, checkModifyAndDecode

Methods inherited from class com.opencloud.util.AbstractFieldsObject
equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject
checkModify, isReadOnly, setReadOnly

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MessageWaitingScheme
```
public MessageWaitingScheme()
```
    Constructs a new MessageWaitingScheme object with no fields set.
  - MessageWaitingScheme
```
public MessageWaitingScheme(byte[] data)
```
    Constructs a new MessageWaitingScheme object from network-encoded data. The data is not decoded and might not be decodable.
    
    Parameters:
    
    data - network-encoded data
    
    Throws:
    
    NullPointerException - if data is null
  - MessageWaitingScheme
```
public MessageWaitingScheme(byte[] data,
                            int start,
                            int len)
```
    Constructs a new MessageWaitingScheme object from part of network-encoded data. The part starts at index start and is len bytes long. The data is not decoded and might not be decodable.
    
    Parameters:
    
    data - network-encoded data
    
    start - starting offset of network-encoded data in byte array
    
    len - default length if not predictable
    
    Throws:
    
    NullPointerException - if data is null
    
    IllegalArgumentException - if len is negative
  - MessageWaitingScheme
```
public MessageWaitingScheme(boolean indicationActive,
                            SMSDataCodingScheme.MessageWaitingScheme.IndicationType indicationType)
```
    Constructs a new MessageWaitingScheme object from given values for all fields.
    
    Parameters:
    
    indicationActive - whether active
    
    indicationType - type of message waiting
  - MessageWaitingScheme
```
public MessageWaitingScheme(int arg)
```
    Constructs a new MessageWaitingScheme object from the given int, making it be read-only (immutable).
    
    Parameters:
    
    arg - int
  - MessageWaitingScheme
```
public MessageWaitingScheme(DataInput in)
                     throws IOException
```
    Constructs a new MessageWaitingScheme object from data deserialized from a stream that was written by toStream(DataOutput).
    
    Parameters:
    
    in - the stream to read from
    
    Throws:
    
    EOFException - if reading is pre-empted by end-of-file
    
    IOException - if the data cannot be read
- Method Detail
  - toStream
```
public void toStream(DataOutput out)
              throws IOException
```
    Serializes this object to a stream in a form suitable for reading by {@link #SMSDataCodingScheme.MessageWaitingScheme(DataInput)}.
    
    Parameters:
    
    out - the stream to write to
    
    Throws:
    
    IOException - if an I/O error occurs
  - hasIndicationActive
```
public boolean hasIndicationActive()
                            throws DecodeException
```
    Tests whether the field IndicationActive has a value.
    
    Returns:
    
    whether the field has a value
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - setIndicationActivePresent
```
public SMSDataCodingScheme.MessageWaitingScheme setIndicationActivePresent(boolean flag)
                                                                    throws IllegalStateException
```
    Sets the presence or absence of the field IndicationActive.
    
    Parameters:
    
    flag - whether the field should be marked as present
    
    Returns:
    
    this
    
    Throws:
    
    IllegalStateException - if this instance has been marked as read-only
  - hasIndicationType
```
public boolean hasIndicationType()
                          throws DecodeException
```
    Tests whether the field IndicationType has a value.
    
    Returns:
    
    whether the field has a value
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - checkFieldsSet
```
public void checkFieldsSet()
                    throws EncodeException
```
    Checks that all mandatory fields are present. Should be called immediately before all calls to encode().
    
    Specified by:
    
    checkFieldsSet in class AbstractLazyEncodedDataObject<SMSDataCodingScheme.MessageWaitingScheme.EncodedValue>
    
    Throws:
    
    EncodeException - if any mandatory field is not present
  - getIndicationActive
```
public boolean getIndicationActive()
                            throws DecodeException
```
    Gets the value of whether active.
    
    Returns:
    
    boolean representation of whether active
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - getIndicationType
```
public SMSDataCodingScheme.MessageWaitingScheme.IndicationType getIndicationType()
                                                                          throws DecodeException
```
    Gets the value of type of message waiting.
    
    Returns:
    
    IndicationType representation of type of message waiting
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - setIndicationActive
```
public SMSDataCodingScheme.MessageWaitingScheme setIndicationActive(boolean value)
                                                             throws IllegalStateException
```
    Sets the value of whether active.
    
    Parameters:
    
    value - boolean representation of whether active
    
    Returns:
    
    this
    
    Throws:
    
    IllegalStateException
  - setIndicationType
```
public SMSDataCodingScheme.MessageWaitingScheme setIndicationType(SMSDataCodingScheme.MessageWaitingScheme.IndicationType value)
                                                           throws IllegalStateException
```
    Sets the value of type of message waiting.
    
    Parameters:
    
    value - IndicationType representation of type of message waiting
    
    Returns:
    
    this
    
    Throws:
    
    IllegalStateException
  - copyOf
```
public static SMSDataCodingScheme.MessageWaitingScheme copyOf(SMSDataCodingScheme.MessageWaitingScheme from)
```
    Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.
    
    Parameters:
    
    from - the object from which to copy
    
    Returns:
    
    MessageWaitingScheme
  - clone
```
public SMSDataCodingScheme.MessageWaitingScheme clone()
```
    Constructs a copy of this object and everything reachable from it.
    
    Specified by:
    
    clone in interface DataObject
    
    Specified by:
    
    clone in class AbstractDataObject
    
    Returns:
    
    copy of object
  - getFieldAccessors
```
public static FieldAccessor[] getFieldAccessors()
```
    Gets a new array of the accessors for fields of this type.
    
    Returns:
    
    FieldAccessor[]
  - getFieldsMap
```
public Map<String,Object> getFieldsMap(boolean withAbsents)
```
    Gets a Map from field-name to field-value for the fields of a sequence. For a field of primitive type, the field-value is boxed. For an absent optional field, the field-value is AbstractFieldsObject.FIELD_ABSENT. For an uninitialised mandatory field, the field-value is AbstractFieldsObject.FIELD_UNINITIALISED. For a field of String type, the encoded form is used if the String cannot be decoded. For a type that represents an OCTET STRING that cannot be decoded, a map from "encodedValue" to the byte array value is returned.
    
    Specified by:
    
    getFieldsMap in class AbstractFieldsObject
    
    Parameters:
    
    withAbsents - whether to put absent optional fields into Map
    
    Returns:
    
    Map from field-name to field-value
  - encodedIsInvalid
```
protected boolean encodedIsInvalid()
```
    Determines whether the encoded form is invalid.
    
    Returns:
    
    boolean
  - getEncodedForm
```
public SMSDataCodingScheme.MessageWaitingScheme.EncodedValue getEncodedForm()
                                                                     throws EncodeException
```
    Gets the encoded form.
    
    Returns:
    
    encoded form
    
    Throws:
    
    EncodeException - if encoding fails
  - getByteArrayForm
```
public byte[] getByteArrayForm()
                        throws EncodeException
```
    Gets the byte array encoded form. The size of the array is the least of 1, 2, 4, or 8 according to the type's bounds. The most significant byte of the numeric value is in the lowest indexed byte of the array.
    
    Returns:
    
    byte array form
    
    Throws:
    
    EncodeException - if encoding fails
  - fromValue
```
protected SMSDataCodingScheme.MessageWaitingScheme.EncodedValue fromValue(int value)
```
    Converts an int to a NamedInteger. Reuses any existing instance where possible.
    
    Specified by:
    
    fromValue in class AbstractLazyEncodedNamedInteger<SMSDataCodingScheme.MessageWaitingScheme.EncodedValue>
    
    Parameters:
    
    value - int
    
    Returns:
    
    NamedInteger
  - encode
```
protected void encode()
```
    Computes the encoded form from the decoded form.
    
    Specified by:
    
    encode in class AbstractLazyEncodedDataObject<SMSDataCodingScheme.MessageWaitingScheme.EncodedValue>
  - decode
```
protected void decode()
```
    Computes the decoded form from the encoded form.
    
    Specified by:
    
    decode in class AbstractLazyEncodedDataObject<SMSDataCodingScheme.MessageWaitingScheme.EncodedValue>

Data Encoding - based on 3GPP TS 23.038 V8.2.0 (2008-09) §4 pp8-10
	7	6	5	4	3	2	1	0
Octet 0	0	0	0	0	Indication active?	0	Indication type

Class SMSDataCodingScheme.MessageWaitingScheme

Nested Class Summary

Field Summary

Fields inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject

Fields inherited from class com.opencloud.slee.resources.cgin.AbstractEncodedDataObject

Fields inherited from class com.opencloud.util.AbstractFieldsObject

Constructor Summary

Method Summary

Methods inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject

Methods inherited from class com.opencloud.util.AbstractFieldsObject

Methods inherited from class com.opencloud.util.AbstractDataObject

Methods inherited from class java.lang.Object

Constructor Detail

MessageWaitingScheme

MessageWaitingScheme

MessageWaitingScheme

MessageWaitingScheme

MessageWaitingScheme

MessageWaitingScheme

Method Detail

toStream

hasIndicationActive

setIndicationActivePresent

hasIndicationType

checkFieldsSet

getIndicationActive

getIndicationType

setIndicationActive

setIndicationType

copyOf

clone

getFieldAccessors

getFieldsMap

encodedIsInvalid

getEncodedForm

getByteArrayForm

fromValue

encode

decode