Class UnrecognizedAttributesBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.UnrecognizedAttributesBuilder
Class that builds
UnrecognizedAttributes
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:
UnrecognizedAttributes createUnrecognizedAttributes(int fooXyzzy, int barBaz) {
return new UnrecognizedAttributesBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of UnrecognizedAttributes, 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
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedUnrecognizedAttributes
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<UnrecognizedAttributes> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UnrecognizedAttributes>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull UnrecognizedAttributes
build()
A newUnrecognizedAttributes
instance.Return current value associated with the property corresponding toUnrecognizedAttributes.getPartial()
.Return current value associated with the property corresponding toUnrecognizedAttributes.getTransitive()
.org.opendaylight.yangtools.yang.common.Uint8
getType()
Return current value associated with the property corresponding toUnrecognizedAttributes.getType()
.byte[]
getValue()
Return current value associated with the property corresponding toUnrecognizedAttributes.getValue()
.key()
Return current value associated with the property corresponding toUnrecognizedAttributes.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnrecognizedAttributes>> augmentationType) Remove an augmentation from this builder's product.setPartial
(Boolean value) Set the property corresponding toUnrecognizedAttributes.getPartial()
to the specified value.setTransitive
(Boolean value) Set the property corresponding toUnrecognizedAttributes.getTransitive()
to the specified value.setType
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toUnrecognizedAttributes.getType()
to the specified value.setValue
(byte[] value) Set the property corresponding toUnrecognizedAttributes.getValue()
to the specified value.Set the key value corresponding toUnrecognizedAttributes.key()
to the specified value.
-
Constructor Details
-
UnrecognizedAttributesBuilder
public UnrecognizedAttributesBuilder()Construct an empty builder. -
UnrecognizedAttributesBuilder
Construct a builder initialized with state from specifiedUnrecognizedAttributes
.- Parameters:
base
- UnrecognizedAttributes from which the builder should be initialized
-
-
Method Details
-
key
Return current value associated with the property corresponding toUnrecognizedAttributes.key()
.- Returns:
- current value
-
getPartial
Return current value associated with the property corresponding toUnrecognizedAttributes.getPartial()
.- Returns:
- current value
-
getTransitive
Return current value associated with the property corresponding toUnrecognizedAttributes.getTransitive()
.- Returns:
- current value
-
getType
public org.opendaylight.yangtools.yang.common.Uint8 getType()Return current value associated with the property corresponding toUnrecognizedAttributes.getType()
.- Returns:
- current value
-
getValue
public byte[] getValue()Return current value associated with the property corresponding toUnrecognizedAttributes.getValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UnrecognizedAttributes>> 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
Set the key value corresponding toUnrecognizedAttributes.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setPartial
Set the property corresponding toUnrecognizedAttributes.getPartial()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransitive
Set the property corresponding toUnrecognizedAttributes.getTransitive()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setType
Set the property corresponding toUnrecognizedAttributes.getType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setValue
Set the property corresponding toUnrecognizedAttributes.getValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public UnrecognizedAttributesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UnrecognizedAttributes> 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 UnrecognizedAttributesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnrecognizedAttributes>> 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 newUnrecognizedAttributes
instance.- Returns:
- A new
UnrecognizedAttributes
instance.
-