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
-
@Generated("mdsal-binding-generator") public class InterfaceBuilder extends Object
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
- 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
-
-
Constructor Summary
Constructors Constructor Description InterfaceBuilder()
Construct an empty builder.InterfaceBuilder(InterfacePhysHoldtimeTop arg)
Construct a new builder initialized from specifiedInterfacePhysHoldtimeTop
.InterfaceBuilder(Interface base)
Construct a builder initialized with state from specifiedInterface
.InterfaceBuilder(SubinterfacesTop arg)
Construct a new builder initialized from specifiedSubinterfacesTop
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull Interface
build()
A newInterface
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Config
getConfig()
Return current value associated with the property corresponding toInterface.getConfig()
.HoldTime
getHoldTime()
Return current value associated with the property corresponding toInterfacePhysHoldtimeTop.getHoldTime()
.String
getName()
Return current value associated with the property corresponding toInterface.getName()
.State
getState()
Return current value associated with the property corresponding toInterface.getState()
.Subinterfaces
getSubinterfaces()
Return current value associated with the property corresponding toSubinterfacesTop.getSubinterfaces()
.InterfaceKey
key()
Return current value associated with the property corresponding toInterface.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)
Set the property corresponding toInterface.getConfig()
to the specified value.InterfaceBuilder
setHoldTime(HoldTime value)
Set the property corresponding toInterfacePhysHoldtimeTop.getHoldTime()
to the specified value.InterfaceBuilder
setName(String value)
Set the property corresponding toInterface.getName()
to the specified value.InterfaceBuilder
setState(State value)
Set the property corresponding toInterface.getState()
to the specified value.InterfaceBuilder
setSubinterfaces(Subinterfaces value)
Set the property corresponding toSubinterfacesTop.getSubinterfaces()
to the specified value.InterfaceBuilder
withKey(InterfaceKey key)
-
-
-
Constructor Detail
-
InterfaceBuilder
public InterfaceBuilder()
Construct an empty builder.
-
InterfaceBuilder
public InterfaceBuilder(InterfacePhysHoldtimeTop arg)
Construct a new builder initialized from specifiedInterfacePhysHoldtimeTop
.- Parameters:
arg
- InterfacePhysHoldtimeTop from which the builder should be initialized
-
InterfaceBuilder
public InterfaceBuilder(SubinterfacesTop arg)
Construct a new builder initialized from specifiedSubinterfacesTop
.- Parameters:
arg
- SubinterfacesTop from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public InterfaceKey key()
Return current value associated with the property corresponding toInterface.key()
.- Returns:
- current value
-
getConfig
public Config getConfig()
Return current value associated with the property corresponding toInterface.getConfig()
.- Returns:
- current value
-
getHoldTime
public HoldTime getHoldTime()
Return current value associated with the property corresponding toInterfacePhysHoldtimeTop.getHoldTime()
.- Returns:
- current value
-
getName
public String getName()
Return current value associated with the property corresponding toInterface.getName()
.- Returns:
- current value
-
getState
public State getState()
Return current value associated with the property corresponding toInterface.getState()
.- Returns:
- current value
-
getSubinterfaces
public Subinterfaces getSubinterfaces()
Return current value associated with the property corresponding toSubinterfacesTop.getSubinterfaces()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Interface>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
public InterfaceBuilder withKey(InterfaceKey key)
-
setConfig
public InterfaceBuilder setConfig(Config value)
Set the property corresponding toInterface.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHoldTime
public InterfaceBuilder setHoldTime(HoldTime value)
Set the property corresponding toInterfacePhysHoldtimeTop.getHoldTime()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setName
public InterfaceBuilder setName(String value)
Set the property corresponding toInterface.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
public InterfaceBuilder setState(State value)
Set the property corresponding toInterface.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSubinterfaces
public InterfaceBuilder setSubinterfaces(Subinterfaces value)
Set the property corresponding toSubinterfacesTop.getSubinterfaces()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
-
-