public final class AccessPointName extends AbstractLazyEncodedByteArray implements FastSerializable
AccessPointName
.
The API offered by this class is as if the type were specified in ASN.1 as follows.
AccessPointName ::= SEQUENCE { networkId CharString, operatorId CharString 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 23.003 V10.0.0 (2010-12) §9 pp30-32 | ||||||||
---|---|---|---|---|---|---|---|---|
8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | |
Octet 0 | Length (n) of 1st label | |||||||
Octet 1 | Characters of 1st label | |||||||
.. | ||||||||
Octet n | ||||||||
... | Further labels |
Modifier and Type | Field and Description |
---|---|
static IA5StringCodec<AccessPointName> |
NETWORKID_CODEC
ASCII/ISO646-US string codec for field NetworkId.
|
static IA5StringCodec<AccessPointName> |
OPERATORID_CODEC
ASCII/ISO646-US string codec for field OperatorId.
|
isDecoded
encoded
FIELD_ABSENT, FIELD_UNINITIALISED
Constructor and Description |
---|
AccessPointName()
Constructs a new AccessPointName object with no fields set.
|
AccessPointName(byte[] data)
Constructs a new AccessPointName object from network-encoded data.
|
AccessPointName(byte[] data,
int start,
int len)
Constructs a new AccessPointName object from part of network-encoded data.
|
AccessPointName(DataInput in)
Constructs a new AccessPointName object from data deserialized from a stream that was written by
toStream(DataOutput) . |
Modifier and Type | Method and Description |
---|---|
void |
checkFieldsSet()
Checks that all mandatory fields are present.
|
AccessPointName |
clone()
Constructs a copy of this object and everything reachable from it.
|
static AccessPointName |
copyOf(AccessPointName 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.
|
String |
getNetworkId()
Gets the value of the network identifier.
|
String |
getNetworkId(StringCodec<AccessPointName> codec)
Gets the value of the network identifier using the given codec.
|
StringCodec<AccessPointName> |
getNetworkIdCodec()
Gets the codec used for field NetworkId.
|
byte[] |
getNetworkIdEncoded()
Gets a clone of the encoded value of the network identifier.
|
String |
getOperatorId()
Gets the value of the operator identifier.
|
String |
getOperatorId(StringCodec<AccessPointName> codec)
Gets the value of the operator identifier using the given codec.
|
StringCodec<AccessPointName> |
getOperatorIdCodec()
Gets the codec used for field OperatorId.
|
byte[] |
getOperatorIdEncoded()
Gets a clone of the encoded value of the operator identifier.
|
boolean |
hasNetworkId()
Tests whether the field NetworkId has a value.
|
boolean |
hasOperatorId()
Tests whether the field OperatorId has a value.
|
AccessPointName |
setNetworkId(String value)
Sets the value of the network identifier.
|
AccessPointName |
setNetworkId(String value,
StringCodec<AccessPointName> codec)
Sets the value of the network identifier using the given codec.
|
AccessPointName |
setNetworkIdEncoded(byte[] encoded)
Sets the encoded value of the network identifier to a clone of the given byte array.
|
AccessPointName |
setOperatorId(String value)
Sets the value of the operator identifier.
|
AccessPointName |
setOperatorId(String value,
StringCodec<AccessPointName> codec)
Sets the value of the operator identifier using the given codec.
|
AccessPointName |
setOperatorIdEncoded(byte[] encoded)
Sets the encoded value of the operator identifier to a clone of the given byte array.
|
void |
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading by
AccessPointName(DataInput) . |
checkDecode, checkModifyAndDecode
equals, hashCode, toString
checkModify, isReadOnly, setReadOnly
public static final IA5StringCodec<AccessPointName> NETWORKID_CODEC
public static final IA5StringCodec<AccessPointName> OPERATORID_CODEC
public AccessPointName()
public AccessPointName(byte[] data)
data
- network-encoded dataNullPointerException
- if data is nullpublic AccessPointName(byte[] data, int start, int len)
start
and is len
bytes long.
The data is not decoded and might not be decodable.data
- network-encoded datastart
- starting offset of network-encoded data in byte arraylen
- default length if not predictableNullPointerException
- if data is nullIllegalArgumentException
- if len is negativepublic AccessPointName(DataInput in) throws IOException
toStream(DataOutput)
.in
- the stream to read fromEOFException
- if reading is pre-empted by end-of-fileIOException
- if the data cannot be readpublic void toStream(DataOutput out) throws IOException
AccessPointName(DataInput)
.toStream
in interface FastSerializable
out
- the stream to write toIOException
- if an I/O error occurspublic boolean hasNetworkId() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean hasOperatorId() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic void checkFieldsSet() throws EncodeException
checkFieldsSet
in class AbstractLazyEncodedDataObject<byte[]>
EncodeException
- if any mandatory field is not presentpublic String getNetworkId() throws DecodeException
getNetworkId(null)
.DecodeException
- if encoded state cannot be decodedpublic String getOperatorId() throws DecodeException
getOperatorId(null)
.DecodeException
- if encoded state cannot be decodedpublic AccessPointName setNetworkId(String value) throws IllegalStateException
value
- String representation of the network identifierIllegalStateException
public AccessPointName setOperatorId(String value) throws IllegalStateException
value
- String representation of the operator identifierIllegalStateException
public String getNetworkId(StringCodec<AccessPointName> codec) throws DecodeException
codec
- StringCodec to use for decodingDecodeException
- if encoded state cannot be decodedpublic byte[] getNetworkIdEncoded()
public AccessPointName setNetworkId(String value, StringCodec<AccessPointName> codec) throws IllegalArgumentException
value
- String representation of the network identifiercodec
- StringCodec to use for encodingIllegalArgumentException
public AccessPointName setNetworkIdEncoded(byte[] encoded)
encoded
- byte[] representation of the network identifierpublic String getOperatorId(StringCodec<AccessPointName> codec) throws DecodeException
codec
- StringCodec to use for decodingDecodeException
- if encoded state cannot be decodedpublic byte[] getOperatorIdEncoded()
public AccessPointName setOperatorId(String value, StringCodec<AccessPointName> codec) throws IllegalArgumentException
value
- String representation of the operator identifiercodec
- StringCodec to use for encodingIllegalArgumentException
public AccessPointName setOperatorIdEncoded(byte[] encoded)
encoded
- byte[] representation of the operator identifierpublic static AccessPointName copyOf(AccessPointName from)
from
- the object from which to copypublic AccessPointName clone()
clone
in interface DataObject
clone
in class AbstractDataObject
public static FieldAccessor[] getFieldAccessors()
public Map<String,Object> getFieldsMap(boolean withAbsents)
getFieldsMap
in class AbstractFieldsObject
withAbsents
- whether to put absent optional fields into Mapprotected boolean encodedIsInvalid()
public byte[] getEncodedForm() throws EncodeException
EncodeException
- if encoding failspublic static int getContainedLength(byte[] data, int start, int len)
start
in the given data
.
The value is not fully decoded and might not be decodable.
Values of this type are of variable length, so the given length
is returned if the data is long enough, otherwise 0 is returned.data
- network-encoded datastart
- index into data where value commenceslen
- length in data to be consideredpublic StringCodec<AccessPointName> getNetworkIdCodec()
public StringCodec<AccessPointName> getOperatorIdCodec()
protected void encode() throws EncodeException
encode
in class AbstractLazyEncodedDataObject<byte[]>
EncodeException
- if cannot encode dataprotected void decode() throws DecodeException
decode
in class AbstractLazyEncodedDataObject<byte[]>
DecodeException
- if cannot decode data