java.lang.Object
- com.opencloud.util.AbstractDataObject
- - com.opencloud.util.AbstractFieldsObject
  - - AbstractEncodedDataObject<T>
    - - AbstractLazyEncodedDataObject<byte[]>
      - AbstractLazyEncodedByteArray
        
        com.opencloud.slee.resources.in.datatypes.cc.BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

BearerCapability.ITU_T.Layer1Capability.Details
```
public static final class BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem
extends AbstractLazyEncodedByteArray
```
Class ParityAndModem represents stop and data bit counts, parity, duplex mode and modem type within a BearerCapability.ITU_T. 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.
```
 ParityAndModem ::= SEQUENCE {
     numberOfStopBits NumberOfStopBits,
     numberOfDataBits NumberOfDataBits,
     parity           Parity,
     modem            Modem       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 ITU-T Q.931 (05/98) §4.5.5 p58

8 7 6 5 4 3 2 1

Octet 5c ext. 0/1 Number of stop bits Number of data bits Parity

Octet 5d* ext. 1 Duplex mode Modem type

The octet numbering in the above table is that used in the cited standard for the octets encoded here.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Modem`	Class Modem represents the DuplexMode and ModemType within a BearerCapability.ITU_T.
`static class`	`BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfDataBits`	ITU-T Number of Data Bits (excluding parity bit if present) constants.
`static class`	`BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfStopBits`	ITU-T Number of Stop Bits constants.
`static class`	`BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Parity`	ITU-T Parity 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
`ParityAndModem()`	Constructs a new ParityAndModem object with no fields set.
`ParityAndModem(byte[] data)`	Constructs a new ParityAndModem object from network-encoded data.
`ParityAndModem(byte[] data, int start, int len)`	Constructs a new ParityAndModem object from part of network-encoded data.
`ParityAndModem(DataInput in)`	Constructs a new ParityAndModem 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.
`BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem`	`clone()`	Constructs a copy of this object and everything reachable from it.
`static BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem`	`copyOf(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem 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.
`BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Modem`	`getModem()`	Gets the value of any DuplexMode and ModemType.
`BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfDataBits`	`getNumberOfDataBits()`	Gets the value of number of data bits excluding parity bit if present.
`BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfStopBits`	`getNumberOfStopBits()`	Gets the value of the number of stop bits.
`BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Parity`	`getParity()`	Gets the value of the parity information.
`boolean`	`hasModem()`	Tests whether the field Modem has a value.
`boolean`	`hasNumberOfDataBits()`	Tests whether the field NumberOfDataBits has a value.
`boolean`	`hasNumberOfStopBits()`	Tests whether the field NumberOfStopBits has a value.
`boolean`	`hasParity()`	Tests whether the field Parity has a value.
`BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem`	`setModem(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Modem value)`	Sets the value of any DuplexMode and ModemType.
`BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem`	`setNumberOfDataBits(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfDataBits value)`	Sets the value of number of data bits excluding parity bit if present.
`BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem`	`setNumberOfStopBits(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfStopBits value)`	Sets the value of the number of stop bits.
`BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem`	`setParity(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Parity value)`	Sets the value of the parity information.
`void`	`setReadOnly()`	Sets this and all its fields to be immutable.
`void`	`toStream(DataOutput out)`	Serializes this object to a stream in a form suitable for reading by {@link #BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem(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

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

- Constructor Detail
  - ParityAndModem
```
public ParityAndModem()
```
    Constructs a new ParityAndModem object with no fields set.
  - ParityAndModem
```
public ParityAndModem(byte[] data)
```
    Constructs a new ParityAndModem 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
  - ParityAndModem
```
public ParityAndModem(byte[] data,
                      int start,
                      int len)
```
    Constructs a new ParityAndModem 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
  - ParityAndModem
```
public ParityAndModem(DataInput in)
               throws IOException
```
    Constructs a new ParityAndModem 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 #BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem(DataInput)}.
    
    Parameters:
    
    out - the stream to write to
    
    Throws:
    
    IOException - if an I/O error occurs
  - hasNumberOfStopBits
```
public boolean hasNumberOfStopBits()
                            throws DecodeException
```
    Tests whether the field NumberOfStopBits has a value.
    
    Returns:
    
    whether the field has a value
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - hasNumberOfDataBits
```
public boolean hasNumberOfDataBits()
                            throws DecodeException
```
    Tests whether the field NumberOfDataBits has a value.
    
    Returns:
    
    whether the field has a value
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - hasParity
```
public boolean hasParity()
                  throws DecodeException
```
    Tests whether the field Parity has a value.
    
    Returns:
    
    whether the field has a value
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - hasModem
```
public boolean hasModem()
                 throws DecodeException
```
    Tests whether the field Modem 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
  - getNumberOfStopBits
```
public BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfStopBits getNumberOfStopBits()
                                                                                                    throws DecodeException
```
    Gets the value of the number of stop bits.
    
    Returns:
    
    NumberOfStopBits representation of the number of stop bits
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - getNumberOfDataBits
```
public BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfDataBits getNumberOfDataBits()
                                                                                                    throws DecodeException
```
    Gets the value of number of data bits excluding parity bit if present.
    
    Returns:
    
    NumberOfDataBits representation of number of data bits excluding parity bit if present
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - getParity
```
public BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Parity getParity()
                                                                                throws DecodeException
```
    Gets the value of the parity information.
    
    Returns:
    
    Parity representation of the parity information
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - getModem
```
public BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Modem getModem()
                                                                              throws DecodeException
```
    Gets the value of any DuplexMode and ModemType.
    
    Returns:
    
    Modem representation of any DuplexMode and ModemType
    
    Throws:
    
    DecodeException - if encoded state cannot be decoded
  - setNumberOfStopBits
```
public BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem setNumberOfStopBits(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfStopBits value)
                                                                                   throws IllegalStateException
```
    Sets the value of the number of stop bits.
    
    Parameters:
    
    value - NumberOfStopBits representation of the number of stop bits
    
    Returns:
    
    this
    
    Throws:
    
    IllegalStateException
  - setNumberOfDataBits
```
public BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem setNumberOfDataBits(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.NumberOfDataBits value)
                                                                                   throws IllegalStateException
```
    Sets the value of number of data bits excluding parity bit if present.
    
    Parameters:
    
    value - NumberOfDataBits representation of number of data bits excluding parity bit if present
    
    Returns:
    
    this
    
    Throws:
    
    IllegalStateException
  - setParity
```
public BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem setParity(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Parity value)
                                                                         throws IllegalStateException
```
    Sets the value of the parity information.
    
    Parameters:
    
    value - Parity representation of the parity information
    
    Returns:
    
    this
    
    Throws:
    
    IllegalStateException
  - setModem
```
public BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem setModem(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem.Modem value)
                                                                        throws IllegalStateException
```
    Sets the value of any DuplexMode and ModemType.
    
    Parameters:
    
    value - Modem representation of any DuplexMode and ModemType
    
    Returns:
    
    this
    
    Throws:
    
    IllegalStateException
  - copyOf
```
public static BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem copyOf(BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem 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:
    
    ParityAndModem
  - clone
```
public BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem 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
  - setReadOnly
```
public void setReadOnly()
```
    Sets this and all its fields to be immutable.
    
    Specified by:
    
    setReadOnly in interface DataObject
    
    Overrides:
    
    setReadOnly in class AbstractDataObject
  - 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 any mandatory field is null or out of range
  - 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, or RateMultiplier required but omitted

Data Encoding - based on ITU-T Q.931 (05/98) §4.5.5 p58
	8	7	6	5	4	3	2	1
Octet 5c	ext. 0/1	Number of stop bits		Number of data bits		Parity
Octet 5d*	ext. 1	Duplex mode	Modem type

Class BearerCapability.ITU_T.Layer1Capability.Details.ParityAndModem

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

ParityAndModem

ParityAndModem

ParityAndModem

ParityAndModem

Method Detail

toStream

hasNumberOfStopBits

hasNumberOfDataBits

hasParity

hasModem

checkFieldsSet

getNumberOfStopBits

getNumberOfDataBits

getParity

getModem

setNumberOfStopBits

setNumberOfDataBits

setParity

setModem

copyOf

clone

setReadOnly

getFieldAccessors

getFieldsMap

encodedIsInvalid

getEncodedForm

getContainedLength

encode

decode