Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pce.id.object
Class PceIdBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pce.id.object.PceIdBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PceId>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PceId,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PceIdBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PceId>
Class that buildsPceIdBuilder
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:
PceIdBuilder createTarget(int fooXyzzy, int barBaz) { return new PceIdBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PceIdBuilder, 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:
PceIdBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PceIdBuilder()
PceIdBuilder(Object arg)
PceIdBuilder(ObjectHeader arg)
PceIdBuilder(PceId base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PceIdBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PceId>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PceId> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.PceIdBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PceId> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PceId>>
E$$augmentation(Class<E$$> augmentationType)
PceId
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getIpAddress()
Boolean
isIgnore()
Boolean
isProcessingRule()
PceIdBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PceId>> augmentationType)
Remove an augmentation from this builder's product.PceIdBuilder
setIgnore(Boolean value)
PceIdBuilder
setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
PceIdBuilder
setProcessingRule(Boolean value)
-
-
-
Constructor Detail
-
PceIdBuilder
public PceIdBuilder()
-
PceIdBuilder
public PceIdBuilder(Object arg)
-
PceIdBuilder
public PceIdBuilder(ObjectHeader arg)
-
PceIdBuilder
public PceIdBuilder(PceId 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.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
-
getIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getIpAddress()
-
isIgnore
public Boolean isIgnore()
-
isProcessingRule
public Boolean isProcessingRule()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PceId>> E$$ augmentation(Class<E$$> augmentationType)
-
setIpAddress
public PceIdBuilder setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
-
setIgnore
public PceIdBuilder setIgnore(Boolean value)
-
setProcessingRule
public PceIdBuilder setProcessingRule(Boolean value)
-
addAugmentation
public PceIdBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PceId> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public PceIdBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PceId>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PceId> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public PceIdBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PceId>> 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 PceId build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PceId>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PceId,IllegalArgumentException>
-
-