Package org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match
Class Ipv6MatchBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv6MatchBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv6Match>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv6Match,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Ipv6MatchBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Ipv6Match>
Class that buildsIpv6Match
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:
Ipv6Match createIpv6Match(int fooXyzzy, int barBaz) { return new Ipv6MatchBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv6Match, 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:
Ipv6Match
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv6MatchBuilder()
Ipv6MatchBuilder(Ipv6MatchFields arg)
Ipv6MatchBuilder(Ipv6Match base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv6MatchBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Match> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Match>>
E$$augmentation(Class<E$$> augmentationType)
Ipv6Match
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix
getIpv6Destination()
Ipv6ExtHeader
getIpv6ExtHeader()
Ipv6Label
getIpv6Label()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
getIpv6NdSll()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address
getIpv6NdTarget()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
getIpv6NdTll()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix
getIpv6Source()
Ipv6MatchBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Match>> augmentationType)
Remove an augmentation from this builder's product.Ipv6MatchBuilder
setIpv6Destination(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
Ipv6MatchBuilder
setIpv6ExtHeader(Ipv6ExtHeader value)
Ipv6MatchBuilder
setIpv6Label(Ipv6Label value)
Ipv6MatchBuilder
setIpv6NdSll(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
Ipv6MatchBuilder
setIpv6NdTarget(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
Ipv6MatchBuilder
setIpv6NdTll(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
Ipv6MatchBuilder
setIpv6Source(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
-
-
-
Constructor Detail
-
Ipv6MatchBuilder
public Ipv6MatchBuilder()
-
Ipv6MatchBuilder
public Ipv6MatchBuilder(Ipv6MatchFields arg)
-
Ipv6MatchBuilder
public Ipv6MatchBuilder(Ipv6Match 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:- Ipv6MatchFields
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIpv6Destination
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix getIpv6Destination()
-
getIpv6ExtHeader
public Ipv6ExtHeader getIpv6ExtHeader()
-
getIpv6Label
public Ipv6Label getIpv6Label()
-
getIpv6NdSll
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getIpv6NdSll()
-
getIpv6NdTarget
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getIpv6NdTarget()
-
getIpv6NdTll
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getIpv6NdTll()
-
getIpv6Source
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix getIpv6Source()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Match>> E$$ augmentation(Class<E$$> augmentationType)
-
setIpv6Destination
public Ipv6MatchBuilder setIpv6Destination(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
-
setIpv6ExtHeader
public Ipv6MatchBuilder setIpv6ExtHeader(Ipv6ExtHeader value)
-
setIpv6Label
public Ipv6MatchBuilder setIpv6Label(Ipv6Label value)
-
setIpv6NdSll
public Ipv6MatchBuilder setIpv6NdSll(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
-
setIpv6NdTarget
public Ipv6MatchBuilder setIpv6NdTarget(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
-
setIpv6NdTll
public Ipv6MatchBuilder setIpv6NdTll(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
-
setIpv6Source
public Ipv6MatchBuilder setIpv6Source(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
-
addAugmentation
public Ipv6MatchBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Match> 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 Ipv6MatchBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Match>> 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 Ipv6Match build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ipv6Match>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ipv6Match,IllegalArgumentException>
-
-