Class FromNeighborBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.match.bgp.neighbor.grouping.match.bgp.neighbor.set.FromNeighborBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FromNeighbor>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FromNeighbor,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FromNeighborBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FromNeighbor>
Class that buildsFromNeighborBuilder
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:
FromNeighborBuilder createTarget(int fooXyzzy, int barBaz) { return new FromNeighborBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FromNeighborBuilder, 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:
FromNeighborBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FromNeighborBuilder()
FromNeighborBuilder(MatchSetOptionsRestrictedGroup arg)
FromNeighborBuilder(BgpNeighbor arg)
FromNeighborBuilder(FromNeighbor base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FromNeighborBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FromNeighbor> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FromNeighbor>>
E$$augmentation(Class<E$$> augmentationType)
FromNeighbor
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MatchSetOptionsRestrictedType
getMatchSetOptions()
String
getNeighborSet()
FromNeighborBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FromNeighbor>> augmentationType)
Remove an augmentation from this builder's product.FromNeighborBuilder
setMatchSetOptions(MatchSetOptionsRestrictedType value)
FromNeighborBuilder
setNeighborSet(String value)
-
-
-
Constructor Detail
-
FromNeighborBuilder
public FromNeighborBuilder()
-
FromNeighborBuilder
public FromNeighborBuilder(BgpNeighbor arg)
-
FromNeighborBuilder
public FromNeighborBuilder(MatchSetOptionsRestrictedGroup arg)
-
FromNeighborBuilder
public FromNeighborBuilder(FromNeighbor 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.params.xml.ns.yang.odl.bgp._default.policy.rev200120.BgpNeighbor
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.MatchSetOptionsRestrictedGroup
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMatchSetOptions
public MatchSetOptionsRestrictedType getMatchSetOptions()
-
getNeighborSet
public String getNeighborSet()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FromNeighbor>> E$$ augmentation(Class<E$$> augmentationType)
-
setMatchSetOptions
public FromNeighborBuilder setMatchSetOptions(MatchSetOptionsRestrictedType value)
-
setNeighborSet
public FromNeighborBuilder setNeighborSet(String value)
-
addAugmentation
public FromNeighborBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FromNeighbor> 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 FromNeighborBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FromNeighbor>> 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 FromNeighbor build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FromNeighbor>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FromNeighbor,IllegalArgumentException>
-
-