Class VlanMatchBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.VlanMatchBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VlanMatch>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VlanMatch,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VlanMatchBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<VlanMatch>
Class that buildsVlanMatchBuilder
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:
VlanMatchBuilder createTarget(int fooXyzzy, int barBaz) { return new VlanMatchBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VlanMatchBuilder, 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:
VlanMatchBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VlanMatchBuilder()
VlanMatchBuilder(VlanMatch base)
VlanMatchBuilder(VlanMatchFields arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VlanMatchBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VlanMatch> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanMatch>>
E$$augmentation(Class<E$$> augmentationType)
VlanMatch
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.VlanId
getVlanId()
org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanPcp
getVlanPcp()
VlanMatchBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanMatch>> augmentationType)
Remove an augmentation from this builder's product.VlanMatchBuilder
setVlanId(VlanId value)
VlanMatchBuilder
setVlanPcp(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanPcp value)
-
-
-
Constructor Detail
-
VlanMatchBuilder
public VlanMatchBuilder()
-
VlanMatchBuilder
public VlanMatchBuilder(VlanMatchFields arg)
-
VlanMatchBuilder
public VlanMatchBuilder(VlanMatch 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.opendaylight.model.match.types.rev131026.VlanMatchFields
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getVlanId
public VlanId getVlanId()
-
getVlanPcp
public org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanPcp getVlanPcp()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanMatch>> E$$ augmentation(Class<E$$> augmentationType)
-
setVlanId
public VlanMatchBuilder setVlanId(VlanId value)
-
setVlanPcp
public VlanMatchBuilder setVlanPcp(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanPcp value)
-
addAugmentation
public VlanMatchBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VlanMatch> 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 VlanMatchBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VlanMatch>> 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 VlanMatch build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VlanMatch>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VlanMatch,IllegalArgumentException>
-
-