Package de.iip_ecosphere.platform.support.aas.basyx2

Class BaSyxProperty.BaSyxPropertyBuilder

java.lang.Object

de.iip_ecosphere.platform.support.aas.basyx2.BaSyxProperty.BaSyxPropertyBuilder

All Implemented Interfaces:

de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder, de.iip_ecosphere.platform.support.aas.RbacReceiver<de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder>, de.iip_ecosphere.platform.support.Builder<de.iip_ecosphere.platform.support.aas.Property>

Enclosing class:

BaSyxProperty

public static class BaSyxProperty.BaSyxPropertyBuilder
extends Object
implements de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder

Builder for BaSyxProperty.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field	Description
private BaSyxProperty	instance
private boolean	isNew
private BaSyxSubmodelElementContainerBuilder<?>	parentBuilder
private org.eclipse.digitaltwin.aas4j.v3.model.Property	property
private org.eclipse.digitaltwin.aas4j.v3.model.DataTypeDefXsd	typeDef

Fields inherited from interface de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder

READ_ONLY, READ_ONLY_FUNC, WRITE_ONLY, WRITE_ONLY_FUNC

Constructor Summary

Constructors

Constructor	Description
BaSyxPropertyBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder, BaSyxProperty instance)	Creates an instance for modifying an existing property.
BaSyxPropertyBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder, String idShort)	Creates an instance.

Method Summary

Modifier and Type	Method	Description
de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder	bind(de.iip_ecosphere.platform.support.aas.Invokable get, de.iip_ecosphere.platform.support.aas.Invokable set)
de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder	bindLazy(de.iip_ecosphere.platform.support.aas.Invokable get, de.iip_ecosphere.platform.support.aas.Invokable set)
de.iip_ecosphere.platform.support.aas.Property	build()
(package private) static BaSyxProperty.BaSyxPropertyBuilder	create(BaSyxSubmodelElementContainerBuilder<?> parentBuilder, String idShort, de.iip_ecosphere.platform.support.aas.Property instance)	Creates a property builder, if possible from instance else from idShort.
BaSyxSubmodelElementContainerBuilder<?>	getParentBuilder()
Object	getValue()
de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder	rbac(de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor auth, de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor.Role role, de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor.RbacAction... actions)
de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder	setDescription(de.iip_ecosphere.platform.support.aas.LangString... description)
de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder	setSemanticId(String refValue)
de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder	setType(de.iip_ecosphere.platform.support.aas.Type type)
de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder	setValue(de.iip_ecosphere.platform.support.aas.Type type, Object value)
de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder	setValue(Object value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder

build, rbac, rbac

Methods inherited from interface de.iip_ecosphere.platform.support.aas.RbacReceiver

rbacAll, rbacAllAuthenticated, rbacDevice, rbacPlatform

Field Details

parentBuilder

private BaSyxSubmodelElementContainerBuilder<?> parentBuilder

instance

private BaSyxProperty instance

property

private org.eclipse.digitaltwin.aas4j.v3.model.Property property

typeDef

private org.eclipse.digitaltwin.aas4j.v3.model.DataTypeDefXsd typeDef

isNew

private boolean isNew

Constructor Details

BaSyxPropertyBuilder

BaSyxPropertyBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder,
 String idShort)

Creates an instance. Prevents external creation.

Parameters:

parentBuilder - the parent builder

idShort - the short name of the property

Throws:

IllegalArgumentException - if idShort is null or empty

BaSyxPropertyBuilder

BaSyxPropertyBuilder(BaSyxSubmodelElementContainerBuilder<?> parentBuilder,
 BaSyxProperty instance)

Creates an instance for modifying an existing property. Prevents external creation.

Parameters:

parentBuilder - the parent builder

instance - the existing property

Method Details

create

static BaSyxProperty.BaSyxPropertyBuilder create(BaSyxSubmodelElementContainerBuilder<?> parentBuilder,
 String idShort,
 de.iip_ecosphere.platform.support.aas.Property instance)

Creates a property builder, if possible from instance else from idShort.

Parameters:

parentBuilder - the parent builder

idShort - the id short

instance - the optional property instance

Returns:

the builder

getParentBuilder

public BaSyxSubmodelElementContainerBuilder<?> getParentBuilder()

Specified by:

getParentBuilder in interface de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder

setType

public de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder setType(de.iip_ecosphere.platform.support.aas.Type type)

Specified by:

setType in interface de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder

bind

public de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder bind(de.iip_ecosphere.platform.support.aas.Invokable get,
 de.iip_ecosphere.platform.support.aas.Invokable set)

Specified by:

bind in interface de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder

bindLazy

public de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder bindLazy(de.iip_ecosphere.platform.support.aas.Invokable get,
 de.iip_ecosphere.platform.support.aas.Invokable set)

Specified by:

bindLazy in interface de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder

setValue

public de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder setValue(de.iip_ecosphere.platform.support.aas.Type type,
 Object value)

Specified by:

setValue in interface de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder

setDescription

public de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder setDescription(de.iip_ecosphere.platform.support.aas.LangString... description)

Specified by:

setDescription in interface de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder

setValue

public de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder setValue(Object value)

Specified by:

setValue in interface de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder

setSemanticId

public de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder setSemanticId(String refValue)

Specified by:

setSemanticId in interface de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder

build

public de.iip_ecosphere.platform.support.aas.Property build()

Specified by:

build in interface de.iip_ecosphere.platform.support.Builder<de.iip_ecosphere.platform.support.aas.Property>

getValue

public Object getValue()
                throws ExecutionException

Specified by:

getValue in interface de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder

Throws:

ExecutionException

rbac

public de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder rbac(de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor auth,
 de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor.Role role,
 de.iip_ecosphere.platform.support.aas.AuthenticationDescriptor.RbacAction... actions)

Specified by:

rbac in interface de.iip_ecosphere.platform.support.aas.RbacReceiver<de.iip_ecosphere.platform.support.aas.Property.PropertyBuilder>