Class VendorInformationObjectBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.vendor.information.objects.VendorInformationObjectBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VendorInformationObject>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VendorInformationObject,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VendorInformationObjectBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<VendorInformationObject>
Class that buildsVendorInformationObjectBuilder
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:
VendorInformationObjectBuilder createTarget(int fooXyzzy, int barBaz) { return new VendorInformationObjectBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VendorInformationObjectBuilder, 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:
VendorInformationObjectBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VendorInformationObjectBuilder()
VendorInformationObjectBuilder(Object arg)
VendorInformationObjectBuilder(ObjectHeader arg)
VendorInformationObjectBuilder(VendorInformationObject base)
VendorInformationObjectBuilder(VendorInformation arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VendorInformationObjectBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VendorInformationObject> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VendorInformationObject>>
E$$augmentation(Class<E$$> augmentationType)
VendorInformationObject
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.EnterpriseNumber
getEnterpriseNumber()
EnterpriseSpecificInformation
getEnterpriseSpecificInformation()
Boolean
getIgnore()
Boolean
getProcessingRule()
Boolean
isIgnore()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isProcessingRule()
Deprecated, for removal: This API element is subject to removal in a future version.VendorInformationObjectBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VendorInformationObject>> augmentationType)
Remove an augmentation from this builder's product.VendorInformationObjectBuilder
setEnterpriseNumber(EnterpriseNumber value)
VendorInformationObjectBuilder
setEnterpriseSpecificInformation(EnterpriseSpecificInformation value)
VendorInformationObjectBuilder
setIgnore(Boolean value)
VendorInformationObjectBuilder
setProcessingRule(Boolean value)
-
-
-
Constructor Detail
-
VendorInformationObjectBuilder
public VendorInformationObjectBuilder()
-
VendorInformationObjectBuilder
public VendorInformationObjectBuilder(Object arg)
-
VendorInformationObjectBuilder
public VendorInformationObjectBuilder(ObjectHeader arg)
-
VendorInformationObjectBuilder
public VendorInformationObjectBuilder(VendorInformation arg)
-
VendorInformationObjectBuilder
public VendorInformationObjectBuilder(VendorInformationObject 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.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.VendorInformation
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ObjectHeader
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getEnterpriseNumber
public EnterpriseNumber getEnterpriseNumber()
-
getEnterpriseSpecificInformation
public EnterpriseSpecificInformation getEnterpriseSpecificInformation()
-
getIgnore
public Boolean getIgnore()
-
isIgnore
@Deprecated(forRemoval=true) public final Boolean isIgnore()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getProcessingRule
public Boolean getProcessingRule()
-
isProcessingRule
@Deprecated(forRemoval=true) public final Boolean isProcessingRule()
Deprecated, for removal: This API element is subject to removal in a future version.
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VendorInformationObject>> E$$ augmentation(Class<E$$> augmentationType)
-
setEnterpriseNumber
public VendorInformationObjectBuilder setEnterpriseNumber(EnterpriseNumber value)
-
setEnterpriseSpecificInformation
public VendorInformationObjectBuilder setEnterpriseSpecificInformation(EnterpriseSpecificInformation value)
-
setIgnore
public VendorInformationObjectBuilder setIgnore(Boolean value)
-
setProcessingRule
public VendorInformationObjectBuilder setProcessingRule(Boolean value)
-
addAugmentation
public VendorInformationObjectBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VendorInformationObject> 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 VendorInformationObjectBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VendorInformationObject>> 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 VendorInformationObject build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VendorInformationObject>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VendorInformationObject,IllegalArgumentException>
-
-