Class ReferenceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.routing.policy.policy.definitions.policy.definition.statements.statement.actions.bgp.actions.set.community.set.community.method.ReferenceBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Reference>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Reference,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ReferenceBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Reference>
Class that buildsReferenceBuilder
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:
ReferenceBuilder createTarget(int fooXyzzy, int barBaz) { return new ReferenceBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ReferenceBuilder, 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:
ReferenceBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ReferenceBuilder()
ReferenceBuilder(Reference base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ReferenceBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Reference> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Reference>>
E$$augmentation(Class<E$$> augmentationType)
Reference
build()
String
getCommunitySetRef()
ReferenceBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Reference>> augmentationType)
Remove an augmentation from this builder's product.ReferenceBuilder
setCommunitySetRef(String value)
-
-
-
Constructor Detail
-
ReferenceBuilder
public ReferenceBuilder()
-
ReferenceBuilder
public ReferenceBuilder(Reference base)
-
-
Method Detail
-
getCommunitySetRef
public String getCommunitySetRef()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Reference>> E$$ augmentation(Class<E$$> augmentationType)
-
setCommunitySetRef
public ReferenceBuilder setCommunitySetRef(String value)
-
addAugmentation
public ReferenceBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Reference> 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 ReferenceBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Reference>> 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 Reference build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Reference>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Reference,IllegalArgumentException>
-
-