PubSubFieldMetaDataConf.Builder (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- com.prosysopc.ua.pubsub.PubSubFieldMetaDataConf.Builder

All Implemented Interfaces:

PubSubConf.Builder<PubSubFieldMetaDataConf.Builder>, PubSubNamedConf.Builder<PubSubFieldMetaDataConf.Builder>

Enclosing class:

PubSubFieldMetaDataConf
```
public static final class PubSubFieldMetaDataConf.Builder
extends Object
implements PubSubNamedConf.Builder<PubSubFieldMetaDataConf.Builder>, PubSubConf.Builder<PubSubFieldMetaDataConf.Builder>
```
Builder for PubSubFieldMetaDataConf.

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<UnsignedInteger>`	`arrayDimensions`
`protected UnsignedByte`	`builtInType`
`protected UUID`	`dataSetFieldId`
`protected UaNodeId`	`dataType`
`protected LocalizedText`	`description`
`protected String`	`name`
`protected Map<UaQualifiedName,Object>`	`properties`
`protected Integer`	`valueRank`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Builder()

Constructors
Modifier	Constructor and Description
`protected`	`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PubSubFieldMetaDataConf.Builder`	`addArrayDimensions(UnsignedInteger arrayDimensions)` Adds the value as an element for `PubSubFieldMetaDataConf.getArrayDimensions()`.
`PubSubFieldMetaDataConf`	`build()` Returns an instance of `PubSubFieldMetaDataConf` with the values given to this builder.
`List<UnsignedInteger>`	`getArrayDimensions()`
`UnsignedByte`	`getBuiltInType()`
`UUID`	`getDataSetFieldId()`
`UaNodeId`	`getDataType()`
`LocalizedText`	`getDescription()`
`String`	`getName()`
`Map<UaQualifiedName,Object>`	`getProperties()`
`Integer`	`getValueRank()`
`PubSubFieldMetaDataConf.Builder`	`putProperties(UaQualifiedName key, Object value)` Puts the key-value pair for `PubSubFieldMetaDataConf.getProperties()`.
`PubSubFieldMetaDataConf.Builder`	`setBuiltInType(UnsignedByte builtInType)` Set the value for `PubSubFieldMetaDataConf.getBuiltInType()`.
`PubSubFieldMetaDataConf.Builder`	`setDataSetFieldId(UUID dataSetFieldId)` Set the value for `PubSubFieldMetaDataConf.getDataSetFieldId()`.
`PubSubFieldMetaDataConf.Builder`	`setDataType(UaNode node)` Convenience method for `setDataType(UaNodeId)` that uses the NodeId of the given node as UaNodeId.
`PubSubFieldMetaDataConf.Builder`	`setDataType(UaNodeId dataType)` Set the value for `PubSubFieldMetaDataConf.getDataType()`.
`PubSubFieldMetaDataConf.Builder`	`setDescription(LocalizedText description)` Set the value for `PubSubFieldMetaDataConf.getDescription()`.
`PubSubFieldMetaDataConf.Builder`	`setName(String name)` Set the value for `PubSubFieldMetaDataConf.getName()`.
`PubSubFieldMetaDataConf.Builder`	`setValueRank(Integer valueRank)` Set the value for `PubSubFieldMetaDataConf.getValueRank()`.
`PubSubConfSpecification`	`specification()` Returns the specification of this object.

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

Methods inherited from interface com.prosysopc.ua.pubsub.PubSubConf.Builder
get, get, set, set, setAll

- Field Detail
  - name
```
protected String name
```
  - arrayDimensions
```
protected List<UnsignedInteger> arrayDimensions
```
  - builtInType
```
protected UnsignedByte builtInType
```
  - dataSetFieldId
```
protected UUID dataSetFieldId
```
  - dataType
```
protected UaNodeId dataType
```
  - description
```
protected LocalizedText description
```
  - properties
```
protected Map<UaQualifiedName,Object> properties
```
  - valueRank
```
protected Integer valueRank
```
- Constructor Detail
  - Builder
```
protected Builder()
```
- Method Detail
  - specification
```
public PubSubConfSpecification specification()
```
    Description copied from interface: PubSubConf.Builder
    
    Returns the specification of this object. Can be used to dynamically set the fields of the PubSubConf object.
    
    Specified by:
    
    specification in interface PubSubConf.Builder<PubSubFieldMetaDataConf.Builder>
  - getName
```
public String getName()
```
  - getArrayDimensions
```
public List<UnsignedInteger> getArrayDimensions()
```
  - getBuiltInType
```
public UnsignedByte getBuiltInType()
```
  - getDataSetFieldId
```
public UUID getDataSetFieldId()
```
  - getDataType
```
public UaNodeId getDataType()
```
  - getDescription
```
public LocalizedText getDescription()
```
  - getProperties
```
public Map<UaQualifiedName,Object> getProperties()
```
  - getValueRank
```
public Integer getValueRank()
```
  - setName
```
public PubSubFieldMetaDataConf.Builder setName(String name)
```
    Set the value for PubSubFieldMetaDataConf.getName(). Returns itself for method chaining.
    
    Specified by:
    
    setName in interface PubSubNamedConf.Builder<PubSubFieldMetaDataConf.Builder>
  - addArrayDimensions
```
public PubSubFieldMetaDataConf.Builder addArrayDimensions(UnsignedInteger arrayDimensions)
```
    Adds the value as an element for PubSubFieldMetaDataConf.getArrayDimensions(). Returns itself for method chaining.
  - setBuiltInType
```
public PubSubFieldMetaDataConf.Builder setBuiltInType(UnsignedByte builtInType)
```
    Set the value for PubSubFieldMetaDataConf.getBuiltInType(). Returns itself for method chaining.
  - setDataSetFieldId
```
public PubSubFieldMetaDataConf.Builder setDataSetFieldId(UUID dataSetFieldId)
```
    Set the value for PubSubFieldMetaDataConf.getDataSetFieldId(). Returns itself for method chaining.
  - setDataType
```
public PubSubFieldMetaDataConf.Builder setDataType(UaNodeId dataType)
```
    Set the value for PubSubFieldMetaDataConf.getDataType(). Returns itself for method chaining.
  - setDataType
```
public PubSubFieldMetaDataConf.Builder setDataType(UaNode node)
```
    Convenience method for setDataType(UaNodeId) that uses the NodeId of the given node as UaNodeId.
  - setDescription
```
public PubSubFieldMetaDataConf.Builder setDescription(LocalizedText description)
```
    Set the value for PubSubFieldMetaDataConf.getDescription(). Returns itself for method chaining.
  - putProperties
```
public PubSubFieldMetaDataConf.Builder putProperties(UaQualifiedName key,
                                                     Object value)
```
    Puts the key-value pair for PubSubFieldMetaDataConf.getProperties(). Returns itself for method chaining.
  - setValueRank
```
public PubSubFieldMetaDataConf.Builder setValueRank(Integer valueRank)
```
    Set the value for PubSubFieldMetaDataConf.getValueRank(). Returns itself for method chaining.
  - build
```
public PubSubFieldMetaDataConf build()
```
    Returns an instance of PubSubFieldMetaDataConf with the values given to this builder.
    
    Specified by:
    
    build in interface PubSubConf.Builder<PubSubFieldMetaDataConf.Builder>

Class PubSubFieldMetaDataConf.Builder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.prosysopc.ua.pubsub.PubSubConf.Builder

Field Detail

name

arrayDimensions

builtInType

dataSetFieldId

dataType

description

properties

valueRank

Constructor Detail

Builder

Method Detail

specification

getName

getArrayDimensions

getBuiltInType

getDataSetFieldId

getDataType

getDescription

getProperties

getValueRank

setName

addArrayDimensions

setBuiltInType

setDataSetFieldId

setDataType

setDataType

setDescription

putProperties

setValueRank

build