java.lang.Object
- com.opencloud.util.AbstractDataObject
- - com.opencloud.util.AbstractFieldsObject
  - - AbstractEncodedDataObject<T>
    - - AbstractLazyEncodedDataObject<byte[]>
      - AbstractLazyEncodedByteArray
        
        com.opencloud.slee.resources.in.datatypes.cc.MSBearerCapability.GSM.Content.NonSpeech.Access

All Implemented Interfaces:: DataObject, Serializable

Enclosing class:: MSBearerCapability.GSM.Content.NonSpeech

public static final class MSBearerCapability.GSM.Content.NonSpeech.Access
extends AbstractLazyEncodedByteArray

Class Access represents flow control of data within a MSBearerCapability. It represents part of a larger octet string; it is not transmitted on a network by itself.

The API offered by this class is as if the type were specified in ASN.1 as follows.

 Access ::= SEQUENCE {
     signallingAccessProtocol SignallingAccessProtocol,
     rateAdaption             RateAdaption,
     o5a                      O5a OPTIONAL,
 }

The class takes care of encoding the field values into a byte-array and decoding field values from a byte-array, the encoded representation being as tabulated below.

Data Encoding based on 3GPP TS 24.008 v4.17.0 (2007-09) §10.5.4.5 pp343-361
	8	7	6	5	4	3	2	1
Octet 5*	ext. 0/1	Access id. (00)		Rate adaption		Signalling access protocol
Octet 5a*	ext. 0/1	Other ITC		Other rate adaption		Spare (000)
Octet 5b*	ext. 1	Hdr/No Hdr	Multiframe	Mode	Logical link identifier	Assignor/ee	Inband negotiation	Spare (0)

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`MSBearerCapability.GSM.Content.NonSpeech.Access.O5a`	Class O5a represents the data of octets 5a..5b in a MSBearerCapability.
`static class`	`MSBearerCapability.GSM.Content.NonSpeech.Access.RateAdaption`	Enumeration of RateAdaption constants.
`static class`	`MSBearerCapability.GSM.Content.NonSpeech.Access.SignallingAccessProtocol`	SignallingAccessProtocol 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
`Access()`	Constructs a new Access object with no fields set.
`Access(byte[] data)`	Constructs a new Access object from network-encoded data.
`Access(byte[] data, int start, int len)`	Constructs a new Access object from part of network-encoded data.
`Access(DataInput in)`	Constructs a new Access 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.
`MSBearerCapability.GSM.Content.NonSpeech.Access`	`clone()`	Constructs a copy of this object and everything reachable from it.
`static MSBearerCapability.GSM.Content.NonSpeech.Access`	`copyOf(MSBearerCapability.GSM.Content.NonSpeech.Access 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.
`static int`	`getContainedLength(byte[] data, int start, int len)`	Determines the length of the encoded value that commences at offset `start` in the given `data`.
`byte[]`	`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.
`MSBearerCapability.GSM.Content.NonSpeech.Access.O5a`	`getO5a()`	Gets the value of the octet 5a..5b data.
`MSBearerCapability.GSM.Content.NonSpeech.Access.RateAdaption`	`getRateAdaption()`	Gets the value of the rate adaption.
`MSBearerCapability.GSM.Content.NonSpeech.Access.SignallingAccessProtocol`	`getSignallingAccessProtocol()`	Gets the value of the signalling access protocol.
`boolean`	`hasO5a()`	Tests whether the field O5a has a value.
`boolean`	`hasRateAdaption()`	Tests whether the field RateAdaption has a value.
`boolean`	`hasSignallingAccessProtocol()`	Tests whether the field SignallingAccessProtocol has a value.
`MSBearerCapability.GSM.Content.NonSpeech.Access`	`setO5a(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a value)`	Sets the value of the octet 5a..5b data.
`MSBearerCapability.GSM.Content.NonSpeech.Access`	`setRateAdaption(MSBearerCapability.GSM.Content.NonSpeech.Access.RateAdaption value)`	Sets the value of the rate adaption.
`MSBearerCapability.GSM.Content.NonSpeech.Access`	`setSignallingAccessProtocol(MSBearerCapability.GSM.Content.NonSpeech.Access.SignallingAccessProtocol value)`	Sets the value of the signalling access protocol.
`void`	`toStream(DataOutput out)`	Serializes this object to a stream in a form suitable for reading by {@link #MSBearerCapability.GSM.Content.NonSpeech.Access(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
  - Access
```
public Access()
```
    Constructs a new Access object with no fields set.
  - Access
```
public Access(byte[] data)
```
    Constructs a new Access 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
  - Access
```
public Access(byte[] data,
              int start,
              int len)
```
    Constructs a new Access 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
  - Access
```
public Access(DataInput in)
       throws IOException
```
    Constructs a new Access 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 #MSBearerCapability.GSM.Content.NonSpeech.Access(DataInput)}.
    
    Parameters:
    
    out - the stream to write to
    
    Throws:
    
    IOException - if an I/O error occurs
  - hasSignallingAccessProtocol
```
public boolean hasSignallingAccessProtocol()
                                    throws DecodeException
```
    Tests whether the field SignallingAccessProtocol has a value.
    
    Returns:
    
    whether the field has a value
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - hasRateAdaption
```
public boolean hasRateAdaption()
                        throws DecodeException
```
    Tests whether the field RateAdaption has a value.
    
    Returns:
    
    whether the field has a value
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - hasO5a
```
public boolean hasO5a()
               throws DecodeException
```
    Tests whether the field O5a 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<byte[]>
    
    Throws:
    
    EncodeException - if any mandatory field is not present
  - getSignallingAccessProtocol
```
public MSBearerCapability.GSM.Content.NonSpeech.Access.SignallingAccessProtocol getSignallingAccessProtocol()
                                                                                                     throws DecodeException
```
    Gets the value of the signalling access protocol.
    
    Returns:
    
    SignallingAccessProtocol representation of the signalling access protocol
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - getRateAdaption
```
public MSBearerCapability.GSM.Content.NonSpeech.Access.RateAdaption getRateAdaption()
                                                                             throws DecodeException
```
    Gets the value of the rate adaption.
    
    Returns:
    
    RateAdaption representation of the rate adaption
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - getO5a
```
public MSBearerCapability.GSM.Content.NonSpeech.Access.O5a getO5a()
                                                           throws DecodeException
```
    Gets the value of the octet 5a*..5b* data.
    
    Returns:
    
    O5a representation of the octet 5a*..5b* data
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - setSignallingAccessProtocol
```
public MSBearerCapability.GSM.Content.NonSpeech.Access setSignallingAccessProtocol(MSBearerCapability.GSM.Content.NonSpeech.Access.SignallingAccessProtocol value)
                                                                            throws IllegalStateException
```
    Sets the value of the signalling access protocol.
    
    Parameters:
    
    value - SignallingAccessProtocol representation of the signalling access protocol
    
    Returns:
    
    this
    
    Throws:
    
    IllegalStateException
  - setRateAdaption
```
public MSBearerCapability.GSM.Content.NonSpeech.Access setRateAdaption(MSBearerCapability.GSM.Content.NonSpeech.Access.RateAdaption value)
                                                                throws IllegalStateException
```
    Sets the value of the rate adaption.
    
    Parameters:
    
    value - RateAdaption representation of the rate adaption
    
    Returns:
    
    this
    
    Throws:
    
    IllegalStateException
  - setO5a
```
public MSBearerCapability.GSM.Content.NonSpeech.Access setO5a(MSBearerCapability.GSM.Content.NonSpeech.Access.O5a value)
                                                       throws IllegalStateException
```
    Sets the value of the octet 5a*..5b* data.
    
    Parameters:
    
    value - O5a representation of the octet 5a*..5b* data
    
    Returns:
    
    this
    
    Throws:
    
    IllegalStateException
  - copyOf
```
public static MSBearerCapability.GSM.Content.NonSpeech.Access copyOf(MSBearerCapability.GSM.Content.NonSpeech.Access 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:
    
    Access
  - clone
```
public MSBearerCapability.GSM.Content.NonSpeech.Access 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 byte[] getEncodedForm()
                      throws EncodeException
```
    Gets the encoded form.
    
    Returns:
    
    encoded form
    
    Throws:
    
    EncodeException - if encoding fails
  - getContainedLength
```
public static int getContainedLength(byte[] data,
                                     int start,
                                     int len)
```
    Determines the length of the encoded value that commences at offset start in the given data. The value is not fully decoded and might not be decodable. If the encoded value ends with a filling field, then the given len is returned. If the encoded value is so currupt that its length cannot be determined, then 0 is returned.
    
    Parameters:
    
    data - network-encoded data
    
    start - index into data where value commences
    
    len - length in data to be considered
    
    Returns:
    
    length of encoded value, or 0 if not decodable
    
    Throws:
    
    NullPointerException - if data is null
  - encode
```
protected void encode()
               throws EncodeException
```
    Computes the encoded form from the decoded form.
    
    Specified by:
    
    encode in class AbstractLazyEncodedDataObject<byte[]>
    
    Throws:
    
    EncodeException - if choice does not match already encoded coding standard
  - decode
```
protected void decode()
               throws DecodeException
```
    Computes the decoded form from the encoded form.
    
    Specified by:
    
    decode in class AbstractLazyEncodedDataObject<byte[]>
    
    Throws:
    
    DecodeException - if too few or too many octets to be decoded

Class MSBearerCapability.GSM.Content.NonSpeech.Access

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

Access

Access

Access

Access

Method Detail

toStream

hasSignallingAccessProtocol

hasRateAdaption

hasO5a

checkFieldsSet

getSignallingAccessProtocol

getRateAdaption

getO5a

setSignallingAccessProtocol

setRateAdaption

setO5a

copyOf

clone

getFieldAccessors

getFieldsMap

encodedIsInvalid

getEncodedForm

getContainedLength

encode

decode