Class EndpointsObjBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.object.EndpointsObjBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<EndpointsObj>
,org.opendaylight.yangtools.concepts.CheckedBuilder<EndpointsObj,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class EndpointsObjBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<EndpointsObj>
Class that buildsEndpointsObj
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:
EndpointsObj createEndpointsObj(int fooXyzzy, int barBaz) { return new EndpointsObjBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EndpointsObj, 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:
EndpointsObj
,Builder
-
-
Constructor Summary
Constructors Constructor Description EndpointsObjBuilder()
EndpointsObjBuilder(Endpoints arg)
EndpointsObjBuilder(EndpointsObj base)
EndpointsObjBuilder(Object arg)
EndpointsObjBuilder(ObjectHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EndpointsObjBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EndpointsObj> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EndpointsObj>>
E$$augmentation(Class<E$$> augmentationType)
EndpointsObj
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.AddressFamily
getAddressFamily()
Boolean
getIgnore()
Boolean
getProcessingRule()
EndpointsObjBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EndpointsObj>> augmentationType)
Remove an augmentation from this builder's product.EndpointsObjBuilder
setAddressFamily(AddressFamily value)
EndpointsObjBuilder
setIgnore(Boolean value)
EndpointsObjBuilder
setProcessingRule(Boolean value)
-
-
-
Constructor Detail
-
EndpointsObjBuilder
public EndpointsObjBuilder()
-
EndpointsObjBuilder
public EndpointsObjBuilder(Object arg)
-
EndpointsObjBuilder
public EndpointsObjBuilder(ObjectHeader arg)
-
EndpointsObjBuilder
public EndpointsObjBuilder(Endpoints arg)
-
EndpointsObjBuilder
public EndpointsObjBuilder(EndpointsObj 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:- ObjectHeader
- Endpoints
- Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAddressFamily
public AddressFamily getAddressFamily()
-
getIgnore
public Boolean getIgnore()
-
getProcessingRule
public Boolean getProcessingRule()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EndpointsObj>> E$$ augmentation(Class<E$$> augmentationType)
-
setAddressFamily
public EndpointsObjBuilder setAddressFamily(AddressFamily value)
-
setIgnore
public EndpointsObjBuilder setIgnore(Boolean value)
-
setProcessingRule
public EndpointsObjBuilder setProcessingRule(Boolean value)
-
addAugmentation
public EndpointsObjBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EndpointsObj> 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 EndpointsObjBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EndpointsObj>> 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 EndpointsObj build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<EndpointsObj>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<EndpointsObj,IllegalArgumentException>
-
-