Class AttributesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.AttributesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Attributes>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Attributes,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AttributesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Attributes>
Class that buildsAttributes
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:
Attributes createAttributes(int fooXyzzy, int barBaz) { return new AttributesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Attributes, 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:
Attributes
,Builder
-
-
Constructor Summary
Constructors Constructor Description AttributesBuilder()
AttributesBuilder(Attributes base)
AttributesBuilder(NextHop arg)
-
Method Summary
-
-
-
Constructor Detail
-
AttributesBuilder
public AttributesBuilder()
-
AttributesBuilder
public AttributesBuilder(NextHop arg)
-
AttributesBuilder
public AttributesBuilder(Attributes 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:- NextHop
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAggregator
public Aggregator getAggregator()
-
getAigp
public Aigp getAigp()
-
getAsPath
public AsPath getAsPath()
-
getAtomicAggregate
public AtomicAggregate getAtomicAggregate()
-
getBgpPrefixSid
public BgpPrefixSid getBgpPrefixSid()
-
getCNextHop
public CNextHop getCNextHop()
-
getClusterId
public ClusterId getClusterId()
-
getCommunities
public List<Communities> getCommunities()
-
getExtendedCommunities
public List<ExtendedCommunities> getExtendedCommunities()
-
getLocalPref
public LocalPref getLocalPref()
-
getMultiExitDisc
public MultiExitDisc getMultiExitDisc()
-
getOrigin
public Origin getOrigin()
-
getOriginatorId
public OriginatorId getOriginatorId()
-
getUnrecognizedAttributes
public Map<UnrecognizedAttributesKey,UnrecognizedAttributes> getUnrecognizedAttributes()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Attributes>> E$$ augmentation(Class<E$$> augmentationType)
-
setAggregator
public AttributesBuilder setAggregator(Aggregator value)
-
setAigp
public AttributesBuilder setAigp(Aigp value)
-
setAsPath
public AttributesBuilder setAsPath(AsPath value)
-
setAtomicAggregate
public AttributesBuilder setAtomicAggregate(AtomicAggregate value)
-
setBgpPrefixSid
public AttributesBuilder setBgpPrefixSid(BgpPrefixSid value)
-
setCNextHop
public AttributesBuilder setCNextHop(CNextHop value)
-
setClusterId
public AttributesBuilder setClusterId(ClusterId value)
-
setCommunities
public AttributesBuilder setCommunities(List<Communities> values)
-
setExtendedCommunities
public AttributesBuilder setExtendedCommunities(List<ExtendedCommunities> values)
-
setLocalPref
public AttributesBuilder setLocalPref(LocalPref value)
-
setMultiExitDisc
public AttributesBuilder setMultiExitDisc(MultiExitDisc value)
-
setOrigin
public AttributesBuilder setOrigin(Origin value)
-
setOriginatorId
public AttributesBuilder setOriginatorId(OriginatorId value)
-
setUnrecognizedAttributes
public AttributesBuilder setUnrecognizedAttributes(Map<UnrecognizedAttributesKey,UnrecognizedAttributes> values)
-
addAugmentation
public AttributesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Attributes> 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 AttributesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Attributes>> 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 Attributes build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Attributes>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Attributes,IllegalArgumentException>
-
-