Class AceIpv4Builder
- 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.ace.ip.ace.ip.version.AceIpv4Builder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AceIpv4>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AceIpv4,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class AceIpv4Builder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<AceIpv4>
Class that buildsAceIpv4Builder
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:
AceIpv4Builder createTarget(int fooXyzzy, int barBaz) { return new AceIpv4BuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AceIpv4Builder, 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:
AceIpv4Builder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AceIpv4Builder()
AceIpv4Builder(AceIpv4 base)
AceIpv4Builder(AclIpv4HeaderFields arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AceIpv4Builder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AceIpv4>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AceIpv4> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.AceIpv4Builder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AceIpv4> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AceIpv4>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
AceIpv4
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.Ipv4Prefix
getDestinationIpv4Network()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix
getSourceIpv4Network()
AceIpv4Builder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AceIpv4>> augmentationType)
Remove an augmentation from this builder's product.AceIpv4Builder
setDestinationIpv4Network(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value)
AceIpv4Builder
setSourceIpv4Network(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value)
-
-
-
Constructor Detail
-
AceIpv4Builder
public AceIpv4Builder()
-
AceIpv4Builder
public AceIpv4Builder(AclIpv4HeaderFields arg)
-
AceIpv4Builder
public AceIpv4Builder(AceIpv4 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.AclIpv4HeaderFields
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getDestinationIpv4Network
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix getDestinationIpv4Network()
-
getSourceIpv4Network
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix getSourceIpv4Network()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AceIpv4>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setDestinationIpv4Network
public AceIpv4Builder setDestinationIpv4Network(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value)
-
setSourceIpv4Network
public AceIpv4Builder setSourceIpv4Network(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value)
-
addAugmentation
public AceIpv4Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AceIpv4> 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
-
addAugmentation
@Deprecated(forRemoval=true) public AceIpv4Builder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AceIpv4>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AceIpv4> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public AceIpv4Builder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AceIpv4>> 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
-
-