Class UserInterfaceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.network.topology.topology.node.termination.point._interface.type.UserInterfaceBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<UserInterface>
,org.opendaylight.yangtools.concepts.CheckedBuilder<UserInterface,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class UserInterfaceBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<UserInterface>
Class that buildsUserInterfaceBuilder
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:
UserInterfaceBuilder createTarget(int fooXyzzy, int barBaz) { return new UserInterfaceBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UserInterfaceBuilder, 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:
UserInterfaceBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description UserInterfaceBuilder()
UserInterfaceBuilder(UserInterface base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UserInterfaceBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UserInterface>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<UserInterface> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UserInterface>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
UserInterface
build()
ExternalReference
getUserInterface()
UserInterfaceBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UserInterface>> augmentationType)
UserInterfaceBuilder
setUserInterface(ExternalReference value)
-
-
-
Constructor Detail
-
UserInterfaceBuilder
public UserInterfaceBuilder()
-
UserInterfaceBuilder
public UserInterfaceBuilder(UserInterface base)
-
-
Method Detail
-
getUserInterface
public ExternalReference getUserInterface()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UserInterface>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setUserInterface
public UserInterfaceBuilder setUserInterface(ExternalReference value)
-
addAugmentation
public UserInterfaceBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UserInterface>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<UserInterface> augmentationValue)
-
removeAugmentation
public UserInterfaceBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UserInterface>> augmentationType)
-
build
public UserInterface build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<UserInterface>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<UserInterface,java.lang.IllegalArgumentException>
-
-