Class PrefixBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.igp.node.attributes.PrefixBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Prefix>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Prefix,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PrefixBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Prefix>
Class that buildsPrefixBuilder
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:
PrefixBuilder createTarget(int fooXyzzy, int barBaz) { return new PrefixBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PrefixBuilder, 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:
PrefixBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PrefixBuilder()
PrefixBuilder(Prefix base)
PrefixBuilder(IgpPrefixAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PrefixBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Prefix> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>>
E$$augmentation(Class<E$$> augmentationType)
Prefix
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Class<? extends FlagIdentity>>
getFlag()
org.opendaylight.yangtools.yang.common.Uint32
getMetric()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getPrefix()
PrefixKey
key()
PrefixBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> augmentationType)
Remove an augmentation from this builder's product.PrefixBuilder
setFlag(List<Class<? extends FlagIdentity>> values)
PrefixBuilder
setMetric(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMetric(Uint32)
instead.PrefixBuilder
setMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
PrefixBuilder
setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
PrefixBuilder
withKey(PrefixKey key)
-
-
-
Constructor Detail
-
PrefixBuilder
public PrefixBuilder()
-
PrefixBuilder
public PrefixBuilder(IgpPrefixAttributes arg)
-
PrefixBuilder
public PrefixBuilder(Prefix 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.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.IgpPrefixAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public PrefixKey key()
-
getFlag
public List<Class<? extends FlagIdentity>> getFlag()
-
getMetric
public org.opendaylight.yangtools.yang.common.Uint32 getMetric()
-
getPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public PrefixBuilder withKey(PrefixKey key)
-
setFlag
public PrefixBuilder setFlag(List<Class<? extends FlagIdentity>> values)
-
setMetric
public PrefixBuilder setMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMetric
@Deprecated(forRemoval=true) public PrefixBuilder setMetric(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMetric(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPrefix
public PrefixBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
-
addAugmentation
public PrefixBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Prefix> 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 PrefixBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> 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 Prefix build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Prefix>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Prefix,IllegalArgumentException>
-
-