Class RedirectAs4Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.redirect.as4.extended.community.RedirectAs4Builder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<RedirectAs4>
,org.opendaylight.yangtools.concepts.CheckedBuilder<RedirectAs4,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class RedirectAs4Builder extends Object implements org.opendaylight.yangtools.concepts.Builder<RedirectAs4>
Class that buildsRedirectAs4Builder
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:
RedirectAs4Builder createTarget(int fooXyzzy, int barBaz) { return new RedirectAs4BuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RedirectAs4Builder, 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:
RedirectAs4Builder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RedirectAs4Builder()
RedirectAs4Builder(RedirectAs4 base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RedirectAs4Builder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RedirectAs4> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RedirectAs4>>
E$$augmentation(Class<E$$> augmentationType)
RedirectAs4
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
getGlobalAdministrator()
org.opendaylight.yangtools.yang.common.Uint16
getLocalAdministrator()
RedirectAs4Builder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RedirectAs4>> augmentationType)
Remove an augmentation from this builder's product.RedirectAs4Builder
setGlobalAdministrator(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
RedirectAs4Builder
setLocalAdministrator(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLocalAdministrator(Uint16)
instead.RedirectAs4Builder
setLocalAdministrator(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
RedirectAs4Builder
public RedirectAs4Builder()
-
RedirectAs4Builder
public RedirectAs4Builder(RedirectAs4 base)
-
-
Method Detail
-
getGlobalAdministrator
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getGlobalAdministrator()
-
getLocalAdministrator
public org.opendaylight.yangtools.yang.common.Uint16 getLocalAdministrator()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RedirectAs4>> E$$ augmentation(Class<E$$> augmentationType)
-
setGlobalAdministrator
public RedirectAs4Builder setGlobalAdministrator(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
-
setLocalAdministrator
public RedirectAs4Builder setLocalAdministrator(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setLocalAdministrator
@Deprecated(forRemoval=true) public RedirectAs4Builder setLocalAdministrator(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLocalAdministrator(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public RedirectAs4Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RedirectAs4> 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 RedirectAs4Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RedirectAs4>> 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 RedirectAs4 build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<RedirectAs4>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<RedirectAs4,IllegalArgumentException>
-
-