Class InterfaceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.endpoint.endpoint.type.InterfaceBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Interface>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Interface,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class InterfaceBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Interface>
Class that buildsInterfaceBuilder
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:
InterfaceBuilder createTarget(int fooXyzzy, int barBaz) { return new InterfaceBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InterfaceBuilder, 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:
InterfaceBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InterfaceBuilder()
InterfaceBuilder(Interface base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InterfaceBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Interface> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Interface>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Interface
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getInterfaceIp()
java.lang.String
getInterfaceName()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress
getMacAddress()
InterfaceBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Interface>> augmentationType)
Remove an augmentation from this builder's product.InterfaceBuilder
setInterfaceIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
InterfaceBuilder
setInterfaceName(java.lang.String value)
InterfaceBuilder
setMacAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress value)
-
-
-
Constructor Detail
-
InterfaceBuilder
public InterfaceBuilder()
-
InterfaceBuilder
public InterfaceBuilder(Interface base)
-
-
Method Detail
-
getInterfaceIp
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getInterfaceIp()
-
getInterfaceName
public java.lang.String getInterfaceName()
-
getMacAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress getMacAddress()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Interface>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setInterfaceIp
public InterfaceBuilder setInterfaceIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setInterfaceName
public InterfaceBuilder setInterfaceName(java.lang.String value)
-
setMacAddress
public InterfaceBuilder setMacAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress value)
-
addAugmentation
public InterfaceBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Interface> 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 InterfaceBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Interface>> 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
-
-