Class ComponentBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.platform.component.top.components.ComponentBuilder
Class that builds
Component 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:
Component createComponent(int fooXyzzy, int barBaz) {
return new ComponentBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Component, 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:
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct an empty builder.ComponentBuilder(Component base) Construct a builder initialized with state from specifiedComponent.Construct a new builder initialized from specifiedPlatformAnchorsTop.Construct a new builder initialized from specifiedPlatformComponentPropertiesTop.Construct a new builder initialized from specifiedPlatformSubcomponentRefTop. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Component> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Component>>
E$$augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Componentbuild()A newComponentinstance.voidfieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toPlatformAnchorsTop.getBackplane().Return current value associated with the property corresponding toPlatformAnchorsTop.getChassis().Return current value associated with the property corresponding toComponent.getConfig().getCpu()Return current value associated with the property corresponding toPlatformAnchorsTop.getCpu().Return current value associated with the property corresponding toPlatformAnchorsTop.getFabric().getFan()Return current value associated with the property corresponding toPlatformAnchorsTop.getFan().Return current value associated with the property corresponding toPlatformAnchorsTop.getIntegratedCircuit().getName()Return current value associated with the property corresponding toComponent.getName().getPort()Return current value associated with the property corresponding toPlatformAnchorsTop.getPort().Return current value associated with the property corresponding toPlatformAnchorsTop.getPowerSupply().Return current value associated with the property corresponding toPlatformComponentPropertiesTop.getProperties().Return current value associated with the property corresponding toPlatformAnchorsTop.getSoftwareModule().getState()Return current value associated with the property corresponding toComponent.getState().Return current value associated with the property corresponding toPlatformAnchorsTop.getStorage().Return current value associated with the property corresponding toPlatformSubcomponentRefTop.getSubcomponents().key()Return current value associated with the property corresponding toComponent.key().removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Component>> augmentationType) Remove an augmentation from this builder's product.setBackplane(Backplane value) Set the property corresponding toPlatformAnchorsTop.getBackplane()to the specified value.setChassis(Chassis value) Set the property corresponding toPlatformAnchorsTop.getChassis()to the specified value.Set the property corresponding toComponent.getConfig()to the specified value.Set the property corresponding toPlatformAnchorsTop.getCpu()to the specified value.Set the property corresponding toPlatformAnchorsTop.getFabric()to the specified value.Set the property corresponding toPlatformAnchorsTop.getFan()to the specified value.Set the property corresponding toPlatformAnchorsTop.getIntegratedCircuit()to the specified value.Set the property corresponding toComponent.getName()to the specified value.Set the property corresponding toPlatformAnchorsTop.getPort()to the specified value.setPowerSupply(PowerSupply value) Set the property corresponding toPlatformAnchorsTop.getPowerSupply()to the specified value.setProperties(Properties value) Set the property corresponding toPlatformComponentPropertiesTop.getProperties()to the specified value.setSoftwareModule(SoftwareModule value) Set the property corresponding toPlatformAnchorsTop.getSoftwareModule()to the specified value.Set the property corresponding toComponent.getState()to the specified value.setStorage(Storage value) Set the property corresponding toPlatformAnchorsTop.getStorage()to the specified value.setSubcomponents(Subcomponents value) Set the property corresponding toPlatformSubcomponentRefTop.getSubcomponents()to the specified value.withKey(ComponentKey key) Set the key value corresponding toComponent.key()to the specified value.
-
Constructor Details
-
ComponentBuilder
public ComponentBuilder()Construct an empty builder. -
ComponentBuilder
Construct a new builder initialized from specifiedPlatformComponentPropertiesTop.- Parameters:
arg- PlatformComponentPropertiesTop from which the builder should be initialized
-
ComponentBuilder
Construct a new builder initialized from specifiedPlatformSubcomponentRefTop.- Parameters:
arg- PlatformSubcomponentRefTop from which the builder should be initialized
-
ComponentBuilder
Construct a new builder initialized from specifiedPlatformAnchorsTop.- Parameters:
arg- PlatformAnchorsTop from which the builder should be initialized
-
ComponentBuilder
Construct a builder initialized with state from specifiedComponent.- Parameters:
base- Component from which the builder should be initialized
-
-
Method Details
-
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
Return current value associated with the property corresponding toComponent.key().- Returns:
- current value
-
getBackplane
Return current value associated with the property corresponding toPlatformAnchorsTop.getBackplane().- Returns:
- current value
-
getChassis
Return current value associated with the property corresponding toPlatformAnchorsTop.getChassis().- Returns:
- current value
-
getConfig
Return current value associated with the property corresponding toComponent.getConfig().- Returns:
- current value
-
getCpu
Return current value associated with the property corresponding toPlatformAnchorsTop.getCpu().- Returns:
- current value
-
getFabric
Return current value associated with the property corresponding toPlatformAnchorsTop.getFabric().- Returns:
- current value
-
getFan
Return current value associated with the property corresponding toPlatformAnchorsTop.getFan().- Returns:
- current value
-
getIntegratedCircuit
Return current value associated with the property corresponding toPlatformAnchorsTop.getIntegratedCircuit().- Returns:
- current value
-
getName
Return current value associated with the property corresponding toComponent.getName().- Returns:
- current value
-
getPort
Return current value associated with the property corresponding toPlatformAnchorsTop.getPort().- Returns:
- current value
-
getPowerSupply
Return current value associated with the property corresponding toPlatformAnchorsTop.getPowerSupply().- Returns:
- current value
-
getProperties
Return current value associated with the property corresponding toPlatformComponentPropertiesTop.getProperties().- Returns:
- current value
-
getSoftwareModule
Return current value associated with the property corresponding toPlatformAnchorsTop.getSoftwareModule().- Returns:
- current value
-
getState
Return current value associated with the property corresponding toComponent.getState().- Returns:
- current value
-
getStorage
Return current value associated with the property corresponding toPlatformAnchorsTop.getStorage().- Returns:
- current value
-
getSubcomponents
Return current value associated with the property corresponding toPlatformSubcomponentRefTop.getSubcomponents().- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Component>> 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
nullif not present - Throws:
NullPointerException- ifaugmentTypeisnull
-
withKey
Set the key value corresponding toComponent.key()to the specified value.- Parameters:
key- desired value- Returns:
- this builder
-
setBackplane
Set the property corresponding toPlatformAnchorsTop.getBackplane()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setChassis
Set the property corresponding toPlatformAnchorsTop.getChassis()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setConfig
Set the property corresponding toComponent.getConfig()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setCpu
Set the property corresponding toPlatformAnchorsTop.getCpu()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setFabric
Set the property corresponding toPlatformAnchorsTop.getFabric()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setFan
Set the property corresponding toPlatformAnchorsTop.getFan()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setIntegratedCircuit
Set the property corresponding toPlatformAnchorsTop.getIntegratedCircuit()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setName
Set the property corresponding toComponent.getName()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setPort
Set the property corresponding toPlatformAnchorsTop.getPort()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setPowerSupply
Set the property corresponding toPlatformAnchorsTop.getPowerSupply()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setProperties
Set the property corresponding toPlatformComponentPropertiesTop.getProperties()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setSoftwareModule
Set the property corresponding toPlatformAnchorsTop.getSoftwareModule()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setState
Set the property corresponding toComponent.getState()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setStorage
Set the property corresponding toPlatformAnchorsTop.getStorage()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setSubcomponents
Set the property corresponding toPlatformSubcomponentRefTop.getSubcomponents()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
addAugmentation
public ComponentBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Component> augmentation) Add an augmentation to this builder's product.- Parameters:
augmentation- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException- ifaugmentationis null
-
removeAugmentation
public ComponentBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Component>> 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
A newComponentinstance.- Returns:
- A new
Componentinstance.
-