Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l2gateways.rev150712.l2gateway.attributes
Class DevicesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l2gateways.rev150712.l2gateway.attributes.DevicesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Devices>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Devices,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class DevicesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Devices>
Class that buildsDevicesBuilder
instances. Overall design of the class is that of a fluent interface, where method chaining is used.In general, this class is supposed to be used like this template:
DevicesBuilder createTarget(int fooXyzzy, int barBaz) { return new DevicesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DevicesBuilder, as instances can be freely passed around without worrying about synchronization issues.
As a side note: method chaining results in:
- very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is
on the stack, so further method invocations just need to fill method arguments for the next method
invocation, which is terminated by
build()
, which is then returned from the method - better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
- better optimization oportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated
- See Also:
DevicesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description DevicesBuilder()
DevicesBuilder(Devices base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DevicesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Devices> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Devices>>
E$$augmentation(Class<E$$> augmentationType)
Devices
build()
String
getDeviceName()
Map<InterfacesKey,Interfaces>
getInterfaces()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getUuid()
DevicesKey
key()
DevicesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Devices>> augmentationType)
Remove an augmentation from this builder's product.DevicesBuilder
setDeviceName(String value)
DevicesBuilder
setInterfaces(Map<InterfacesKey,Interfaces> values)
DevicesBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
DevicesBuilder
withKey(DevicesKey key)
-
-
-
Constructor Detail
-
DevicesBuilder
public DevicesBuilder()
-
DevicesBuilder
public DevicesBuilder(Devices base)
-
-
Method Detail
-
key
public DevicesKey key()
-
getDeviceName
public String getDeviceName()
-
getInterfaces
public Map<InterfacesKey,Interfaces> getInterfaces()
-
getUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getUuid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Devices>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public DevicesBuilder withKey(DevicesKey key)
-
setDeviceName
public DevicesBuilder setDeviceName(String value)
-
setInterfaces
public DevicesBuilder setInterfaces(Map<InterfacesKey,Interfaces> values)
-
setUuid
public DevicesBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public DevicesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Devices> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public DevicesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Devices>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
public Devices build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Devices>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Devices,IllegalArgumentException>
-
-