Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.interfaces.top.interfaces
Class InterfaceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.interfaces.top.interfaces.InterfaceBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Interface>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Interface,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class InterfaceBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Interface>
Class that buildsInterface
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:
Interface createInterface(int fooXyzzy, int barBaz) { return new InterfaceBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Interface, 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 opportunities, 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:
Interface
,Builder
-
-
Constructor Summary
Constructors Constructor Description InterfaceBuilder()
InterfaceBuilder(InterfacePhysHoldtimeTop arg)
InterfaceBuilder(Interface base)
InterfaceBuilder(SubinterfacesTop arg)
-
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(Class<E$$> augmentationType)
Interface
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Config
getConfig()
HoldTime
getHoldTime()
String
getName()
State
getState()
Subinterfaces
getSubinterfaces()
InterfaceKey
key()
InterfaceBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Interface>> augmentationType)
Remove an augmentation from this builder's product.InterfaceBuilder
setConfig(Config value)
InterfaceBuilder
setHoldTime(HoldTime value)
InterfaceBuilder
setName(String value)
InterfaceBuilder
setState(State value)
InterfaceBuilder
setSubinterfaces(Subinterfaces value)
InterfaceBuilder
withKey(InterfaceKey key)
-
-
-
Constructor Detail
-
InterfaceBuilder
public InterfaceBuilder()
-
InterfaceBuilder
public InterfaceBuilder(InterfacePhysHoldtimeTop arg)
-
InterfaceBuilder
public InterfaceBuilder(SubinterfacesTop arg)
-
InterfaceBuilder
public InterfaceBuilder(Interface 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:- SubinterfacesTop
- InterfacePhysHoldtimeTop
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public InterfaceKey key()
-
getConfig
public Config getConfig()
-
getHoldTime
public HoldTime getHoldTime()
-
getName
public String getName()
-
getState
public State getState()
-
getSubinterfaces
public Subinterfaces getSubinterfaces()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Interface>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public InterfaceBuilder withKey(InterfaceKey key)
-
setConfig
public InterfaceBuilder setConfig(Config value)
-
setHoldTime
public InterfaceBuilder setHoldTime(HoldTime value)
-
setName
public InterfaceBuilder setName(String value)
-
setState
public InterfaceBuilder setState(State value)
-
setSubinterfaces
public InterfaceBuilder setSubinterfaces(Subinterfaces 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:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public InterfaceBuilder removeAugmentation(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
-
build
public Interface build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Interface>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Interface,IllegalArgumentException>
-
-