Class InterfaceRefBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412._interface.ref.InterfaceRefBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<InterfaceRef>
,org.opendaylight.yangtools.concepts.CheckedBuilder<InterfaceRef,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class InterfaceRefBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<InterfaceRef>
Class that buildsInterfaceRefBuilder
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:
InterfaceRefBuilder createTarget(int fooXyzzy, int barBaz) { return new InterfaceRefBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InterfaceRefBuilder, 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:
InterfaceRefBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InterfaceRefBuilder()
InterfaceRefBuilder(InterfaceRef base)
InterfaceRefBuilder(InterfaceRefStateContainer arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InterfaceRefBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceRef>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceRef> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceRef>>
E$$augmentation(Class<E$$> augmentationType)
InterfaceRef
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Config
getConfig()
State
getState()
InterfaceRefBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceRef>> augmentationType)
InterfaceRefBuilder
setConfig(Config value)
InterfaceRefBuilder
setState(State value)
-
-
-
Constructor Detail
-
InterfaceRefBuilder
public InterfaceRefBuilder()
-
InterfaceRefBuilder
public InterfaceRefBuilder(InterfaceRefStateContainer arg)
-
InterfaceRefBuilder
public InterfaceRefBuilder(InterfaceRef 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.http.openconfig.net.yang.interfaces.rev160412.InterfaceRefStateContainer
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getConfig
public Config getConfig()
-
getState
public State getState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceRef>> E$$ augmentation(Class<E$$> augmentationType)
-
setConfig
public InterfaceRefBuilder setConfig(Config value)
-
setState
public InterfaceRefBuilder setState(State value)
-
addAugmentation
public InterfaceRefBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceRef>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceRef> augmentationValue)
-
removeAugmentation
public InterfaceRefBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceRef>> augmentationType)
-
build
public InterfaceRef build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<InterfaceRef>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<InterfaceRef,IllegalArgumentException>
-
-