Class PeerGroupsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.PeerGroupsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PeerGroups>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PeerGroups,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PeerGroupsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PeerGroups>
Class that buildsPeerGroupsBuilder
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:
PeerGroupsBuilder createTarget(int fooXyzzy, int barBaz) { return new PeerGroupsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PeerGroupsBuilder, 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:
PeerGroupsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PeerGroupsBuilder()
PeerGroupsBuilder(PeerGroups base)
PeerGroupsBuilder(BgpPeerGroup arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PeerGroupsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerGroups>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PeerGroups> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerGroups>>
E$$augmentation(Class<E$$> augmentationType)
PeerGroups
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<PeerGroup>
getPeerGroup()
PeerGroupsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerGroups>> augmentationType)
PeerGroupsBuilder
setPeerGroup(List<PeerGroup> values)
-
-
-
Constructor Detail
-
PeerGroupsBuilder
public PeerGroupsBuilder()
-
PeerGroupsBuilder
public PeerGroupsBuilder(BgpPeerGroup arg)
-
PeerGroupsBuilder
public PeerGroupsBuilder(PeerGroups 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.http.openconfig.net.yang.bgp.rev151009.BgpPeerGroup
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerGroups>> E$$ augmentation(Class<E$$> augmentationType)
-
setPeerGroup
public PeerGroupsBuilder setPeerGroup(List<PeerGroup> values)
-
addAugmentation
public PeerGroupsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerGroups>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PeerGroups> augmentationValue)
-
removeAugmentation
public PeerGroupsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerGroups>> augmentationType)
-
build
public PeerGroups build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PeerGroups>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PeerGroups,IllegalArgumentException>
-
-