Class AceIpBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.ace.matches.ace.type.AceIpBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AceIp>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AceIp,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AceIpBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<AceIp>
Class that buildsAceIpBuilder
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:
AceIpBuilder createTarget(int fooXyzzy, int barBaz) { return new AceIpBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AceIpBuilder, 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:
AceIpBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AceIpBuilder()
AceIpBuilder(AceIp base)
AceIpBuilder(AclIpHeaderFields arg)
AceIpBuilder(AclTransportHeaderFields arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AceIpBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AceIp> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AceIp>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
AceIp
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.AceIpVersion
getAceIpVersion()
DestinationPortRange
getDestinationPortRange()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Dscp
getDscp()
org.opendaylight.yangtools.yang.common.Uint8
getProtocol()
SourcePortRange
getSourcePortRange()
AceIpBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AceIp>> augmentationType)
Remove an augmentation from this builder's product.AceIpBuilder
setAceIpVersion(AceIpVersion value)
AceIpBuilder
setDestinationPortRange(DestinationPortRange value)
AceIpBuilder
setDscp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Dscp value)
AceIpBuilder
setProtocol(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetProtocol(Uint8)
instead.AceIpBuilder
setProtocol(org.opendaylight.yangtools.yang.common.Uint8 value)
AceIpBuilder
setSourcePortRange(SourcePortRange value)
-
-
-
Constructor Detail
-
AceIpBuilder
public AceIpBuilder()
-
AceIpBuilder
public AceIpBuilder(AclIpHeaderFields arg)
-
AceIpBuilder
public AceIpBuilder(AclTransportHeaderFields arg)
-
AceIpBuilder
public AceIpBuilder(AceIp 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.ietf.params.xml.ns.yang.ietf.packet.fields.rev160218.AclTransportHeaderFields
- org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.packet.fields.rev160218.AclIpHeaderFields
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAceIpVersion
public AceIpVersion getAceIpVersion()
-
getDestinationPortRange
public DestinationPortRange getDestinationPortRange()
-
getDscp
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Dscp getDscp()
-
getProtocol
public org.opendaylight.yangtools.yang.common.Uint8 getProtocol()
-
getSourcePortRange
public SourcePortRange getSourcePortRange()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AceIp>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setAceIpVersion
public AceIpBuilder setAceIpVersion(AceIpVersion value)
-
setDestinationPortRange
public AceIpBuilder setDestinationPortRange(DestinationPortRange value)
-
setDscp
public AceIpBuilder setDscp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Dscp value)
-
setProtocol
public AceIpBuilder setProtocol(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setProtocol
@Deprecated(forRemoval=true) public AceIpBuilder setProtocol(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetProtocol(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setSourcePortRange
public AceIpBuilder setSourcePortRange(SourcePortRange value)
-
addAugmentation
public AceIpBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AceIp> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public AceIpBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AceIp>> 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
-
-