Class InPhyPortBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.in.phy.port._case.InPhyPortBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<InPhyPort>
,org.opendaylight.yangtools.concepts.CheckedBuilder<InPhyPort,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class InPhyPortBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<InPhyPort>
Class that buildsInPhyPortBuilder
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:
InPhyPortBuilder createTarget(int fooXyzzy, int barBaz) { return new InPhyPortBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InPhyPortBuilder, 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:
InPhyPortBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InPhyPortBuilder()
InPhyPortBuilder(InPhyPort base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InPhyPortBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InPhyPort> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InPhyPort>>
E$$augmentation(Class<E$$> augmentationType)
InPhyPort
build()
PortNumber
getPortNumber()
InPhyPortBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InPhyPort>> augmentationType)
Remove an augmentation from this builder's product.InPhyPortBuilder
setPortNumber(PortNumber value)
-
-
-
Constructor Detail
-
InPhyPortBuilder
public InPhyPortBuilder()
-
InPhyPortBuilder
public InPhyPortBuilder(InPhyPort base)
-
-
Method Detail
-
getPortNumber
public PortNumber getPortNumber()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InPhyPort>> E$$ augmentation(Class<E$$> augmentationType)
-
setPortNumber
public InPhyPortBuilder setPortNumber(PortNumber value)
-
addAugmentation
public InPhyPortBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InPhyPort> 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 InPhyPortBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InPhyPort>> 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 InPhyPort build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<InPhyPort>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<InPhyPort,IllegalArgumentException>
-
-