Class SetNextHopActionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.set.next.hop.action._case.SetNextHopActionBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SetNextHopAction>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SetNextHopAction,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SetNextHopActionBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SetNextHopAction>
Class that buildsSetNextHopAction
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:
SetNextHopAction createSetNextHopAction(int fooXyzzy, int barBaz) { return new SetNextHopActionBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SetNextHopAction, 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 opportunities, 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:
SetNextHopAction
,Builder
-
-
Constructor Summary
Constructors Constructor Description SetNextHopActionBuilder()
SetNextHopActionBuilder(SetNextHopAction base)
SetNextHopActionBuilder(Address arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SetNextHopActionBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetNextHopAction> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNextHopAction>>
E$$augmentation(Class<E$$> augmentationType)
SetNextHopAction
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Address
getAddress()
SetNextHopActionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNextHopAction>> augmentationType)
Remove an augmentation from this builder's product.SetNextHopActionBuilder
setAddress(Address value)
-
-
-
Constructor Detail
-
SetNextHopActionBuilder
public SetNextHopActionBuilder()
-
SetNextHopActionBuilder
public SetNextHopActionBuilder(Address arg)
-
SetNextHopActionBuilder
public SetNextHopActionBuilder(SetNextHopAction 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.Address
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAddress
public Address getAddress()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNextHopAction>> E$$ augmentation(Class<E$$> augmentationType)
-
setAddress
public SetNextHopActionBuilder setAddress(Address value)
-
addAugmentation
public SetNextHopActionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetNextHopAction> 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 SetNextHopActionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNextHopAction>> 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 SetNextHopAction build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SetNextHopAction>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SetNextHopAction,IllegalArgumentException>
-
-