CS1IPAvailable (CGIN Unified RA API (3.1.9-SNAPSHOT))

java.lang.Object
- com.opencloud.util.AbstractDataObject
- - com.opencloud.util.AbstractFieldsObject
  - - ExtendibleOctetString
    - - CS1IPAvailable

All Implemented Interfaces:

DataObject, Serializable
```
public class CS1IPAvailable
extends ExtendibleOctetString
```
API for Core-INAP-CS1-DataTypes.IPAvailable. Generated from the following ASN.1 type definition and the adaptations below.
```
 IPAvailable ::=
     OCTET STRING (SIZE (1..1000))
 Core-INAP-CS1-DataTypes {
     IPAvailable {
         @extendible
     }
 }
 
```
Each subclass adds a ContainedValue field alongside the ByteArray field inherited from ExtendibleOctetString. The position of this class in the type hierarchy restricts what types of contained value can be used.
Used as field type by CS1InitialDPArg.

Used as field type by CS1AssistRequestInstructionsArg.
See Also:

Serialized Form

Field Summary
- Fields inherited from class com.opencloud.util.AbstractFieldsObject
  FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors
Constructor Description

CS1IPAvailable()
Nullary constructor.

CS1IPAvailable(byte[] byteArray)
Constructs from a given initial byte array value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CS1IPAvailable`	`clone()`	Constructs a copy of this object and everything reachable from it.
`static CS1IPAvailable`	`copyOf(CS1IPAvailable 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.
`CS1IPAvailable`	`setByteArray(byte[] value)`	Sets the value of the field byteArray.

Methods inherited from class com.opencloud.slee.resources.cgin.ExtendibleOctetString
getByteArray, getFieldAccessors, getFieldsMap, hasByteArray

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
  - CS1IPAvailable
```
public CS1IPAvailable()
```
    Nullary constructor.
  - CS1IPAvailable
```
public CS1IPAvailable(byte[] byteArray)
```
    Constructs from a given initial byte array value.
    
    Parameters:
    
    byteArray - byte array
- Method Detail
  - clone
```
public CS1IPAvailable 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
  - copyOf
```
public static CS1IPAvailable copyOf(CS1IPAvailable 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:
    
    CS1IPAvailable
  - setByteArray
```
public CS1IPAvailable setByteArray(byte[] value)
                            throws IllegalStateException
```
    Sets the value of the field byteArray.
    
    Overrides:
    
    setByteArray in class ExtendibleOctetString
    
    Parameters:
    
    value - the new value for the field
    
    Returns:
    
    this
    
    Throws:
    
    IllegalStateException - if this instance has been marked as read-only