Package org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.set.field._case
Class SetFieldBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.set.field._case.SetFieldBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SetField>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SetField,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SetFieldBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SetField>
Class that buildsSetField
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:
SetField createSetField(int fooXyzzy, int barBaz) { return new SetFieldBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SetField, 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:
SetField
,Builder
-
-
Constructor Summary
Constructors Constructor Description SetFieldBuilder()
SetFieldBuilder(SetField base)
SetFieldBuilder(Match arg)
-
Method Summary
-
-
-
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:- Match
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getEthernetMatch
public EthernetMatch getEthernetMatch()
-
getIcmpv4Match
public Icmpv4Match getIcmpv4Match()
-
getIcmpv6Match
public Icmpv6Match getIcmpv6Match()
-
getInPhyPort
public NodeConnectorId getInPhyPort()
-
getInPort
public NodeConnectorId getInPort()
-
getIpMatch
public IpMatch getIpMatch()
-
getLayer3Match
public Layer3Match getLayer3Match()
-
getLayer4Match
public Layer4Match getLayer4Match()
-
getMetadata
public Metadata getMetadata()
-
getPacketTypeMatch
public PacketTypeMatch getPacketTypeMatch()
-
getProtocolMatchFields
public ProtocolMatchFields getProtocolMatchFields()
-
getTcpFlagsMatch
public TcpFlagsMatch getTcpFlagsMatch()
-
getTunnel
public Tunnel getTunnel()
-
getVlanMatch
public VlanMatch getVlanMatch()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetField>> E$$ augmentation(Class<E$$> augmentationType)
-
setEthernetMatch
public SetFieldBuilder setEthernetMatch(EthernetMatch value)
-
setIcmpv4Match
public SetFieldBuilder setIcmpv4Match(Icmpv4Match value)
-
setIcmpv6Match
public SetFieldBuilder setIcmpv6Match(Icmpv6Match value)
-
setInPhyPort
public SetFieldBuilder setInPhyPort(NodeConnectorId value)
-
setInPort
public SetFieldBuilder setInPort(NodeConnectorId value)
-
setIpMatch
public SetFieldBuilder setIpMatch(IpMatch value)
-
setLayer3Match
public SetFieldBuilder setLayer3Match(Layer3Match value)
-
setLayer4Match
public SetFieldBuilder setLayer4Match(Layer4Match value)
-
setMetadata
public SetFieldBuilder setMetadata(Metadata value)
-
setPacketTypeMatch
public SetFieldBuilder setPacketTypeMatch(PacketTypeMatch value)
-
setProtocolMatchFields
public SetFieldBuilder setProtocolMatchFields(ProtocolMatchFields value)
-
setTcpFlagsMatch
public SetFieldBuilder setTcpFlagsMatch(TcpFlagsMatch value)
-
setTunnel
public SetFieldBuilder setTunnel(Tunnel value)
-
setVlanMatch
public SetFieldBuilder setVlanMatch(VlanMatch value)
-
addAugmentation
public SetFieldBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetField> 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 SetFieldBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetField>> 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 SetField build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SetField>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SetField,IllegalArgumentException>
-
-