Class PeerPrefBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.pcep.session.state.PeerPrefBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PeerPref>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PeerPref,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PeerPrefBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PeerPref>
Class that buildsPeerPref
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:
PeerPref createPeerPref(int fooXyzzy, int barBaz) { return new PeerPrefBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PeerPref, 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:
PeerPref
,Builder
-
-
Constructor Summary
Constructors Constructor Description PeerPrefBuilder()
PeerPrefBuilder(PeerPref base)
PeerPrefBuilder(Preferences arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PeerPrefBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerPref> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerPref>>
E$$augmentation(Class<E$$> augmentationType)
PeerPref
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getDeadtimer()
String
getIpAddress()
org.opendaylight.yangtools.yang.common.Uint8
getKeepalive()
org.opendaylight.yangtools.yang.common.Uint16
getSessionId()
PeerPrefBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerPref>> augmentationType)
Remove an augmentation from this builder's product.PeerPrefBuilder
setDeadtimer(org.opendaylight.yangtools.yang.common.Uint8 value)
PeerPrefBuilder
setIpAddress(String value)
PeerPrefBuilder
setKeepalive(org.opendaylight.yangtools.yang.common.Uint8 value)
PeerPrefBuilder
setSessionId(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
PeerPrefBuilder
public PeerPrefBuilder()
-
PeerPrefBuilder
public PeerPrefBuilder(Preferences arg)
-
PeerPrefBuilder
public PeerPrefBuilder(PeerPref 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:- Preferences
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getDeadtimer
public org.opendaylight.yangtools.yang.common.Uint8 getDeadtimer()
-
getIpAddress
public String getIpAddress()
-
getKeepalive
public org.opendaylight.yangtools.yang.common.Uint8 getKeepalive()
-
getSessionId
public org.opendaylight.yangtools.yang.common.Uint16 getSessionId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerPref>> E$$ augmentation(Class<E$$> augmentationType)
-
setDeadtimer
public PeerPrefBuilder setDeadtimer(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setIpAddress
public PeerPrefBuilder setIpAddress(String value)
-
setKeepalive
public PeerPrefBuilder setKeepalive(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setSessionId
public PeerPrefBuilder setSessionId(org.opendaylight.yangtools.yang.common.Uint16 value)
-
addAugmentation
public PeerPrefBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerPref> 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 PeerPrefBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerPref>> 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 PeerPref build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PeerPref>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PeerPref,IllegalArgumentException>
-
-