Class SubPortsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.trunks.rev170118.trunk.attributes.SubPortsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SubPorts>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SubPorts,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SubPortsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SubPorts>
Class that buildsSubPortsBuilder
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:
SubPortsBuilder createTarget(int fooXyzzy, int barBaz) { return new SubPortsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SubPortsBuilder, 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:
SubPortsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SubPortsBuilder()
SubPortsBuilder(SubPortAttributes arg)
SubPortsBuilder(SubPorts base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubPortsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SubPorts> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubPorts>>
E$$augmentation(Class<E$$> augmentationType)
SubPorts
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getPortId()
org.opendaylight.yangtools.yang.common.Uint32
getSegmentationId()
Class<? extends NetworkTypeBase>
getSegmentationType()
SubPortsKey
key()
SubPortsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubPorts>> augmentationType)
Remove an augmentation from this builder's product.SubPortsBuilder
setPortId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
SubPortsBuilder
setSegmentationId(org.opendaylight.yangtools.yang.common.Uint32 value)
SubPortsBuilder
setSegmentationType(Class<? extends NetworkTypeBase> value)
SubPortsBuilder
withKey(SubPortsKey key)
-
-
-
Constructor Detail
-
SubPortsBuilder
public SubPortsBuilder()
-
SubPortsBuilder
public SubPortsBuilder(SubPortAttributes arg)
-
SubPortsBuilder
public SubPortsBuilder(SubPorts base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- SubPortAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public SubPortsKey key()
-
getPortId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getPortId()
-
getSegmentationId
public org.opendaylight.yangtools.yang.common.Uint32 getSegmentationId()
-
getSegmentationType
public Class<? extends NetworkTypeBase> getSegmentationType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubPorts>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public SubPortsBuilder withKey(SubPortsKey key)
-
setPortId
public SubPortsBuilder setPortId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setSegmentationId
public SubPortsBuilder setSegmentationId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSegmentationType
public SubPortsBuilder setSegmentationType(Class<? extends NetworkTypeBase> value)
-
addAugmentation
public SubPortsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SubPorts> 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 SubPortsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubPorts>> 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 SubPorts build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SubPorts>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SubPorts,IllegalArgumentException>
-
-