Class InPortBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.in.port._case.InPortBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<InPort>
,org.opendaylight.yangtools.concepts.CheckedBuilder<InPort,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class InPortBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<InPort>
Class that buildsInPortBuilder
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:
InPortBuilder createTarget(int fooXyzzy, int barBaz) { return new InPortBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InPortBuilder, 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:
InPortBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InPortBuilder()
InPortBuilder(InPort base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description InPortBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InPort>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<InPort> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.InPortBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InPort> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InPort>>
E$$augmentation(Class<E$$> augmentationType)
InPort
build()
PortNumber
getPortNumber()
InPortBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InPort>> augmentationType)
Remove an augmentation from this builder's product.InPortBuilder
setPortNumber(PortNumber value)
-
-
-
Constructor Detail
-
InPortBuilder
public InPortBuilder()
-
InPortBuilder
public InPortBuilder(InPort base)
-
-
Method Detail
-
getPortNumber
public PortNumber getPortNumber()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InPort>> E$$ augmentation(Class<E$$> augmentationType)
-
setPortNumber
public InPortBuilder setPortNumber(PortNumber value)
-
addAugmentation
public InPortBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InPort> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public InPortBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InPort>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<InPort> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public InPortBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InPort>> 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 InPort build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<InPort>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<InPort,IllegalArgumentException>
-
-