EncoderContext (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- com.prosysopc.ua.stack.encoding.EncoderContext

```
public class EncoderContext
extends Object
```
This context is used when encoding OPC UA DataTypes, it holds the UaDataTypeSpecification related to the types. You can also obtain these via getDataTypeSpecification(UaNodeId), or e.g. specifically for Structure by getStructureSpecification(UaNodeId), which can then be used to make instances of the given Structure or process then in a general manner (note that for non-null Structures you can obtain it also via Structure.specification(). Normally you should use the EncoderContext from the UaClient/UaServer object.

Constructor Summary

Constructors
Constructor and Description
`EncoderContext(NamespaceTable namespaceTable, ServerTable serverTable)` Constructor for EncoderContext.
`EncoderContext(NamespaceTable namespaceTable, ServerTable serverTable, int maxMessageSize)` Constructor for EncoderContext.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDataTypeSpecification(UaDataTypeSpecification specification)` Adds the given `UaDataTypeSpecification` to be part of this context.
`void`	`addEnumerationSpecification(EnumerationSpecification specification)` Deprecated. use `addDataTypeSpecification(UaDataTypeSpecification)` instead.
`void`	`addStructureSpecification(StructureSpecification specification)` Deprecated. use `addDataTypeSpecification(UaDataTypeSpecification)` instead.
`static EncoderContext`	`coreNamespaceOnly()` Returns an unmodifiable `EncoderContext` instance that only handles the core namespace (`NamespaceTable.OPCUA_NAMESPACE`).
`Object`	`decode(ExtensionObject[] values)` Decodes the given `ExtensionObject` array, returns an array of the least common subtype of the decoded `Structure`s.
`Object`	`decode(ExtensionObject[] values, NamespaceTable namespaceTable)` Decodes the given `ExtensionObject` array, returns an array of the least common subtype of the decoded `Structure`s.
`UaDataTypeSpecification`	`getDataTypeSpecification(UaNodeId id)` Returns `UaDataTypeSpecification` that matches the given id or null if not found.
`Map<UaNodeId,UaDataTypeSpecification>`	`getDataTypeSpecifications()` Returns all `UaDataTypeSpecification`.
`static EncoderContext`	`getDefaultInstance()` Deprecated. This method should not be called, instead use the EncoderContext from UaClient or UaServer. This context can only handle the `NamespaceTable.OPCUA_NAMESPACE`.
`EnumerationSpecification`	`getEnumerationSpecification(UaNodeId id)` Returns `EnumerationSpecification` that matches the given id.
`int`	`getMaxArrayLength()` Getter for the field `maxArrayLength`.
`int`	`getMaxByteStringLength()` Getter for the field `maxByteStringLength`.
`int`	`getMaxMessageSize()` Getter for the field `maxMessageSize`.
`int`	`getMaxStringLength()` Getter for the field `maxStringLength`.
`NamespaceTable`	`getNamespaceTable()` Getter for the field `namespaceTable`.
`OptionSetSpecification`	`getOptionSetSpecification(UaNodeId id)` Returns `OptionSetSpecification` that matches the given id.
`ServerTable`	`getServerTable()` Getter for the field `serverTable`.
`SimpleTypeSpecification`	`getSimpleTypeSpecification(UaNodeId id)` Returns `SimpleTypeSpecification` for the given id (can be any encoding id or type id).
`StructureSpecification`	`getStructureSpecification(UaNodeId id)` Returns `StructureSpecification` for the given id (can be any encoding id or type id).
`void`	`registerModel(CommonCodegenModel model)` Register an information model to use in this `EncoderContext`.
`void`	`removeDataTypeSpecification(UaNodeId typeId)` Removes a previously added `UaDataTypeSpecification` based on the `UaDataTypeSpecification.getTypeId()`.
`void`	`removeDataTypeSpecifications(UaNamespace namespace)` Removes previously added `UaDataTypeSpecification` based on the `UaNamespace`.
`void`	`setDynamicDataTypeSpecificationProvider(Function<UaNodeId,UaDataTypeSpecification> provider)` Sets a provider that is called if given `UaDataTypeSpecification` is not already added to this `EncoderContext`.
`void`	`setMaxArrayLength(int maxArrayLength)` Setter for the field `maxArrayLength`.
`void`	`setMaxByteStringLength(int maxByteStringLength)` Setter for the field `maxByteStringLength`.
`void`	`setMaxMessageSize(int encodeMessageMaxSize)` Setter for the field `maxMessageSize`.
`void`	`setMaxStringLength(int maxStringLength)` Setter for the field `maxStringLength`.
`void`	`setNamespaceTable(NamespaceTable namespaceTable)` Setter for the field `namespaceTable`.
`void`	`setServerTable(ServerTable serverTable)` Setter for the field `serverTable`.
`EncoderContext`	`shallowCopy()` Returns a new EncoderContext with same values.
`String`	`toString()`

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

- Constructor Detail
  - EncoderContext
```
public EncoderContext(NamespaceTable namespaceTable,
                      ServerTable serverTable)
```
    Constructor for EncoderContext.
    
    Parameters:
    
    namespaceTable - a NamespaceTable object.
    
    serverTable - a ServerTable object.
  - EncoderContext
```
public EncoderContext(NamespaceTable namespaceTable,
                      ServerTable serverTable,
                      int maxMessageSize)
```
    Constructor for EncoderContext.
    
    Parameters:
    
    namespaceTable - a NamespaceTable object.
    
    serverTable - a ServerTable object.
    
    encodeableSerializer - a com.prosysopc.ua.stack.encoding.binary.IEncodeableSerializer object.
    
    maxMessageSize - a int.
- Method Detail
  - coreNamespaceOnly
```
public static EncoderContext coreNamespaceOnly()
```
    Returns an unmodifiable EncoderContext instance that only handles the core namespace (NamespaceTable.OPCUA_NAMESPACE). This should only be used in places where custom types are not used. Any setters and mutating operations call on this instance shall throw UnsupportedOperationException.
  - getDefaultInstance
```
@Deprecated
public static EncoderContext getDefaultInstance()
```
    Deprecated. This method should not be called, instead use the EncoderContext from UaClient or UaServer. This context can only handle the NamespaceTable.OPCUA_NAMESPACE.
    
    Get the default encoder context.
  - addDataTypeSpecification
```
public void addDataTypeSpecification(UaDataTypeSpecification specification)
```
    Adds the given UaDataTypeSpecification to be part of this context.
  - addEnumerationSpecification
```
@Deprecated
public void addEnumerationSpecification(EnumerationSpecification specification)
```
    Deprecated. use addDataTypeSpecification(UaDataTypeSpecification) instead.
    
    Adds the given EnumerationSpecification to this context. Overrides existing mappings if any.
  - addStructureSpecification
```
@Deprecated
public void addStructureSpecification(StructureSpecification specification)
```
    Deprecated. use addDataTypeSpecification(UaDataTypeSpecification) instead.
    
    Adds the given StructureSpecification to this context. Maps the specification such that it will be returned by getStructureSpecification(UaNodeId) for any of it's encoding or type ids. Overrides existing mappings if any.
  - decode
```
public Object decode(ExtensionObject[] values)
              throws DecodingException
```
    Decodes the given ExtensionObject array, returns an array of the least common subtype of the decoded Structures. Throws DecodingException if decoding fails.
    
    Throws:
    
    DecodingException
  - decode
```
public Object decode(ExtensionObject[] values,
                     NamespaceTable namespaceTable)
              throws DecodingException
```
    Decodes the given ExtensionObject array, returns an array of the least common subtype of the decoded Structures. Throws DecodingException if decoding fails. The given NamespaceTable is given to ExtensionObject.decode(EncoderContext, NamespaceTable).
    
    Throws:
    
    DecodingException
  - getDataTypeSpecification
```
public UaDataTypeSpecification getDataTypeSpecification(UaNodeId id)
```
    Returns UaDataTypeSpecification that matches the given id or null if not found.
  - getDataTypeSpecifications
```
public Map<UaNodeId,UaDataTypeSpecification> getDataTypeSpecifications()
```
    Returns all UaDataTypeSpecification. The returned Map is unmodifiable.
  - getEnumerationSpecification
```
public EnumerationSpecification getEnumerationSpecification(UaNodeId id)
```
    Returns EnumerationSpecification that matches the given id. Returns null if not found.
  - getMaxArrayLength
```
public int getMaxArrayLength()
```
    Getter for the field maxArrayLength.
    
    Returns:
    
    a int.
  - getMaxByteStringLength
```
public int getMaxByteStringLength()
```
    Getter for the field maxByteStringLength.
    
    Returns:
    
    a int.
  - getMaxMessageSize
```
public int getMaxMessageSize()
```
    Getter for the field maxMessageSize.
    
    Returns:
    
    a int.
  - getMaxStringLength
```
public int getMaxStringLength()
```
    Getter for the field maxStringLength.
    
    Returns:
    
    a int.
  - getNamespaceTable
```
public NamespaceTable getNamespaceTable()
```
    Getter for the field namespaceTable.
    
    Returns:
    
    a NamespaceTable object.
  - getOptionSetSpecification
```
public OptionSetSpecification getOptionSetSpecification(UaNodeId id)
```
    Returns OptionSetSpecification that matches the given id. Returns null if not found. Note that this will also return specifications for OptionSetStructures.
  - getServerTable
```
public ServerTable getServerTable()
```
    Getter for the field serverTable.
    
    Returns:
    
    a ServerTable object.
  - getSimpleTypeSpecification
```
public SimpleTypeSpecification getSimpleTypeSpecification(UaNodeId id)
```
    Returns SimpleTypeSpecification for the given id (can be any encoding id or type id). Returns null if not found.
  - getStructureSpecification
```
public StructureSpecification getStructureSpecification(UaNodeId id)
```
    Returns StructureSpecification for the given id (can be any encoding id or type id). Returns null if not found. Note that this will also return specifications for OptionSetStructures.
  - registerModel
```
public void registerModel(CommonCodegenModel model)
```
    Register an information model to use in this EncoderContext. This is equivalent of calling addDataTypeSpecification(UaDataTypeSpecification) for all CodegenModel.getSpecifications().
  - removeDataTypeSpecification
```
public void removeDataTypeSpecification(UaNodeId typeId)
```
    Removes a previously added UaDataTypeSpecification based on the UaDataTypeSpecification.getTypeId(). In the case of StructureSpecification the parameter can be also any of the encoding ids. This method shall not be called while another thread is calling any of the addXXX methods, doing so may produce undefined results. If you remove UaDataTypeSpecifications that were added via registerModel(CommonCodegenModel), i.e. Codegen, you must do so again before they work again.
  - removeDataTypeSpecifications
```
public void removeDataTypeSpecifications(UaNamespace namespace)
```
    Removes previously added UaDataTypeSpecification based on the UaNamespace. Note! This method shall not be called while another thread is calling any of the addXXX methods, doing so may produce undefined results. If you remove a namespace whose UaDataTypeSpecification were added via registerModel(CommonCodegenModel), i.e. Codegen, you must do so again before they work again.
  - setDynamicDataTypeSpecificationProvider
```
public void setDynamicDataTypeSpecificationProvider(Function<UaNodeId,UaDataTypeSpecification> provider)
```
    Sets a provider that is called if given UaDataTypeSpecification is not already added to this EncoderContext.
  - setMaxArrayLength
```
public void setMaxArrayLength(int maxArrayLength)
```
    Setter for the field maxArrayLength.
    
    Parameters:
    
    maxArrayLength - a int.
  - setMaxByteStringLength
```
public void setMaxByteStringLength(int maxByteStringLength)
```
    Setter for the field maxByteStringLength.
    
    Parameters:
    
    maxByteStringLength - a int.
  - setMaxMessageSize
```
public void setMaxMessageSize(int encodeMessageMaxSize)
```
    Setter for the field maxMessageSize.
    
    Parameters:
    
    encodeMessageMaxSize - a int.
  - setMaxStringLength
```
public void setMaxStringLength(int maxStringLength)
```
    Setter for the field maxStringLength.
    
    Parameters:
    
    maxStringLength - a int.
  - setNamespaceTable
```
public void setNamespaceTable(NamespaceTable namespaceTable)
```
    Setter for the field namespaceTable.
    
    Parameters:
    
    namespaceTable - a NamespaceTable object.
  - setServerTable
```
public void setServerTable(ServerTable serverTable)
```
    Setter for the field serverTable.
    
    Parameters:
    
    serverTable - a ServerTable object.
  - shallowCopy
```
public EncoderContext shallowCopy()
```
    Returns a new EncoderContext with same values. NamespaceTable and ServerTable refers to same objects as this one.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class EncoderContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EncoderContext

EncoderContext

Method Detail

coreNamespaceOnly

getDefaultInstance

addDataTypeSpecification

addEnumerationSpecification

addStructureSpecification

decode

decode

getDataTypeSpecification

getDataTypeSpecifications

getEnumerationSpecification

getMaxArrayLength

getMaxByteStringLength

getMaxMessageSize

getMaxStringLength

getNamespaceTable

getOptionSetSpecification

getServerTable

getSimpleTypeSpecification

getStructureSpecification

registerModel

removeDataTypeSpecification

removeDataTypeSpecifications

setDynamicDataTypeSpecificationProvider

setMaxArrayLength

setMaxByteStringLength

setMaxMessageSize

setMaxStringLength

setNamespaceTable

setServerTable

shallowCopy

toString