Class EthernetMatchBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.EthernetMatchBuilder
-
@Generated("mdsal-binding-generator") public class EthernetMatchBuilder extends Object
Class that buildsEthernetMatch
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:
EthernetMatch createEthernetMatch(int fooXyzzy, int barBaz) { return new EthernetMatchBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EthernetMatch, 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:
EthernetMatch
- 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
-
-
Constructor Summary
Constructors Constructor Description EthernetMatchBuilder()
Construct an empty builder.EthernetMatchBuilder(EthernetMatchFields arg)
Construct a new builder initialized from specifiedEthernetMatchFields
.EthernetMatchBuilder(EthernetMatch base)
Construct a builder initialized with state from specifiedEthernetMatch
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EthernetMatchBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EthernetMatch> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetMatch>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull EthernetMatch
build()
A newEthernetMatch
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.EthernetDestination
getEthernetDestination()
Return current value associated with the property corresponding toEthernetMatchFields.getEthernetDestination()
.EthernetSource
getEthernetSource()
Return current value associated with the property corresponding toEthernetMatchFields.getEthernetSource()
.EthernetType
getEthernetType()
Return current value associated with the property corresponding toEthernetMatchFields.getEthernetType()
.EthernetMatchBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetMatch>> augmentationType)
Remove an augmentation from this builder's product.EthernetMatchBuilder
setEthernetDestination(EthernetDestination value)
Set the property corresponding toEthernetMatchFields.getEthernetDestination()
to the specified value.EthernetMatchBuilder
setEthernetSource(EthernetSource value)
Set the property corresponding toEthernetMatchFields.getEthernetSource()
to the specified value.EthernetMatchBuilder
setEthernetType(EthernetType value)
Set the property corresponding toEthernetMatchFields.getEthernetType()
to the specified value.
-
-
-
Constructor Detail
-
EthernetMatchBuilder
public EthernetMatchBuilder()
Construct an empty builder.
-
EthernetMatchBuilder
public EthernetMatchBuilder(EthernetMatchFields arg)
Construct a new builder initialized from specifiedEthernetMatchFields
.- Parameters:
arg
- EthernetMatchFields from which the builder should be initialized
-
EthernetMatchBuilder
public EthernetMatchBuilder(EthernetMatch base)
Construct a builder initialized with state from specifiedEthernetMatch
.- Parameters:
base
- EthernetMatch from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getEthernetDestination
public EthernetDestination getEthernetDestination()
Return current value associated with the property corresponding toEthernetMatchFields.getEthernetDestination()
.- Returns:
- current value
-
getEthernetSource
public EthernetSource getEthernetSource()
Return current value associated with the property corresponding toEthernetMatchFields.getEthernetSource()
.- Returns:
- current value
-
getEthernetType
public EthernetType getEthernetType()
Return current value associated with the property corresponding toEthernetMatchFields.getEthernetType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetMatch>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setEthernetDestination
public EthernetMatchBuilder setEthernetDestination(EthernetDestination value)
Set the property corresponding toEthernetMatchFields.getEthernetDestination()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEthernetSource
public EthernetMatchBuilder setEthernetSource(EthernetSource value)
Set the property corresponding toEthernetMatchFields.getEthernetSource()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEthernetType
public EthernetMatchBuilder setEthernetType(EthernetType value)
Set the property corresponding toEthernetMatchFields.getEthernetType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public EthernetMatchBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EthernetMatch> 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 EthernetMatchBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetMatch>> 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 @NonNull EthernetMatch build()
A newEthernetMatch
instance.- Returns:
- A new
EthernetMatch
instance.
-
-