Class PcepCreateP2pTunnelInputBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev181109.PcepCreateP2pTunnelInputBuilder
Class that builds
PcepCreateP2pTunnelInput
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:
PcepCreateP2pTunnelInput createPcepCreateP2pTunnelInput(int fooXyzzy, int barBaz) {
return new PcepCreateP2pTunnelInputBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of PcepCreateP2pTunnelInput, 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.Construct a new builder initialized from specifiedNetworkTopologyReference
.Construct a new builder initialized from specifiedSubmitInstructionInput
.Construct a new builder initialized from specifiedAttributeFilters
.Construct a new builder initialized from specifiedPriority
.Construct a new builder initialized from specifiedTunnelAttributes
.Construct a new builder initialized from specifiedTunnelP2pPathCfgAttributes
.Construct a builder initialized with state from specifiedPcepCreateP2pTunnelInput
.Construct a new builder initialized from specifiedTunnelPcepLinkCfgAttributes
.Construct a new builder initialized from specifiedCreateP2pTunnelInput
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<PcepCreateP2pTunnelInput> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<PcepCreateP2pTunnelInput>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull PcepCreateP2pTunnelInput
build()
A newPcepCreateP2pTunnelInput
instance.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Return current value associated with the property corresponding toTunnelPcepLinkCfgAttributes.getBandwidth()
.Return current value associated with the property corresponding toTunnelPcepLinkCfgAttributes.getClassType()
.Return current value associated with the property corresponding toSubmitInstructionInput.getDeadline()
.Return current value associated with the property corresponding toCreateP2pTunnelInput.getDestination()
.Return current value associated with the property corresponding toAttributeFilters.getExcludeAny()
.Return current value associated with the property corresponding toTunnelP2pPathCfgAttributes.getExplicitHops()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toPriority.getHoldPriority()
.getId()
Return current value associated with the property corresponding toSubmitInstructionInput.getId()
.Return current value associated with the property corresponding toAttributeFilters.getIncludeAll()
.Return current value associated with the property corresponding toAttributeFilters.getIncludeAny()
.Return current value associated with the property corresponding toTunnelAttributes.getLabelRecordingDesired()
.Return current value associated with the property corresponding toTunnelAttributes.getLocalProtectionDesired()
.Return current value associated with the property corresponding toNetworkTopologyReference.getNetworkTopologyRef()
.Return current value associated with the property corresponding toSubmitInstructionInput.getPreconditions()
.Return current value associated with the property corresponding toTunnelAttributes.getSessionName()
.Return current value associated with the property corresponding toTunnelAttributes.getSeStyleDesired()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toPriority.getSetupPriority()
.Return current value associated with the property corresponding toCreateP2pTunnelInput.getSource()
.Return current value associated with the property corresponding toTunnelPcepLinkCfgAttributes.getSymbolicPathName()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<PcepCreateP2pTunnelInput>> augmentationType) Remove an augmentation from this builder's product.setBandwidth
(Bandwidth value) Set the property corresponding toTunnelPcepLinkCfgAttributes.getBandwidth()
to the specified value.setClassType
(ClassType value) Set the property corresponding toTunnelPcepLinkCfgAttributes.getClassType()
to the specified value.setDeadline
(Nanotime value) Set the property corresponding toSubmitInstructionInput.getDeadline()
to the specified value.setDestination
(Destination value) Set the property corresponding toCreateP2pTunnelInput.getDestination()
to the specified value.setExcludeAny
(AttributeFilter value) Set the property corresponding toAttributeFilters.getExcludeAny()
to the specified value.setExplicitHops
(Map<ExplicitHopsKey, ExplicitHops> values) Set the property corresponding toTunnelP2pPathCfgAttributes.getExplicitHops()
to the specified value.setHoldPriority
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toPriority.getHoldPriority()
to the specified value.setId
(InstructionId value) Set the property corresponding toSubmitInstructionInput.getId()
to the specified value.setIncludeAll
(AttributeFilter value) Set the property corresponding toAttributeFilters.getIncludeAll()
to the specified value.setIncludeAny
(AttributeFilter value) Set the property corresponding toAttributeFilters.getIncludeAny()
to the specified value.setLabelRecordingDesired
(Boolean value) Set the property corresponding toTunnelAttributes.getLabelRecordingDesired()
to the specified value.setLocalProtectionDesired
(Boolean value) Set the property corresponding toTunnelAttributes.getLocalProtectionDesired()
to the specified value.Set the property corresponding toNetworkTopologyReference.getNetworkTopologyRef()
to the specified value.setPreconditions
(Set<InstructionId> values) Set the property corresponding toSubmitInstructionInput.getPreconditions()
to the specified value.setSessionName
(String value) Set the property corresponding toTunnelAttributes.getSessionName()
to the specified value.setSeStyleDesired
(Boolean value) Set the property corresponding toTunnelAttributes.getSeStyleDesired()
to the specified value.setSetupPriority
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toPriority.getSetupPriority()
to the specified value.Set the property corresponding toCreateP2pTunnelInput.getSource()
to the specified value.setSymbolicPathName
(String value) Set the property corresponding toTunnelPcepLinkCfgAttributes.getSymbolicPathName()
to the specified value.
-
Constructor Details
-
PcepCreateP2pTunnelInputBuilder
public PcepCreateP2pTunnelInputBuilder()Construct an empty builder. -
PcepCreateP2pTunnelInputBuilder
Construct a new builder initialized from specifiedCreateP2pTunnelInput
.- Parameters:
arg
- CreateP2pTunnelInput from which the builder should be initialized
-
PcepCreateP2pTunnelInputBuilder
Construct a new builder initialized from specifiedSubmitInstructionInput
.- Parameters:
arg
- SubmitInstructionInput from which the builder should be initialized
-
PcepCreateP2pTunnelInputBuilder
Construct a new builder initialized from specifiedNetworkTopologyReference
.- Parameters:
arg
- NetworkTopologyReference from which the builder should be initialized
-
PcepCreateP2pTunnelInputBuilder
Construct a new builder initialized from specifiedTunnelP2pPathCfgAttributes
.- Parameters:
arg
- TunnelP2pPathCfgAttributes from which the builder should be initialized
-
PcepCreateP2pTunnelInputBuilder
Construct a new builder initialized from specifiedTunnelPcepLinkCfgAttributes
.- Parameters:
arg
- TunnelPcepLinkCfgAttributes from which the builder should be initialized
-
PcepCreateP2pTunnelInputBuilder
Construct a new builder initialized from specifiedTunnelAttributes
.- Parameters:
arg
- TunnelAttributes from which the builder should be initialized
-
PcepCreateP2pTunnelInputBuilder
Construct a new builder initialized from specifiedPriority
.- Parameters:
arg
- Priority from which the builder should be initialized
-
PcepCreateP2pTunnelInputBuilder
Construct a new builder initialized from specifiedAttributeFilters
.- Parameters:
arg
- AttributeFilters from which the builder should be initialized
-
PcepCreateP2pTunnelInputBuilder
Construct a builder initialized with state from specifiedPcepCreateP2pTunnelInput
.- Parameters:
base
- PcepCreateP2pTunnelInput from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
-
getBandwidth
Return current value associated with the property corresponding toTunnelPcepLinkCfgAttributes.getBandwidth()
.- Returns:
- current value
-
getClassType
Return current value associated with the property corresponding toTunnelPcepLinkCfgAttributes.getClassType()
.- Returns:
- current value
-
getDeadline
Return current value associated with the property corresponding toSubmitInstructionInput.getDeadline()
.- Returns:
- current value
-
getDestination
Return current value associated with the property corresponding toCreateP2pTunnelInput.getDestination()
.- Returns:
- current value
-
getExcludeAny
Return current value associated with the property corresponding toAttributeFilters.getExcludeAny()
.- Returns:
- current value
-
getExplicitHops
Return current value associated with the property corresponding toTunnelP2pPathCfgAttributes.getExplicitHops()
.- Returns:
- current value
-
getHoldPriority
public org.opendaylight.yangtools.yang.common.Uint8 getHoldPriority()Return current value associated with the property corresponding toPriority.getHoldPriority()
.- Returns:
- current value
-
getId
Return current value associated with the property corresponding toSubmitInstructionInput.getId()
.- Returns:
- current value
-
getIncludeAll
Return current value associated with the property corresponding toAttributeFilters.getIncludeAll()
.- Returns:
- current value
-
getIncludeAny
Return current value associated with the property corresponding toAttributeFilters.getIncludeAny()
.- Returns:
- current value
-
getLabelRecordingDesired
Return current value associated with the property corresponding toTunnelAttributes.getLabelRecordingDesired()
.- Returns:
- current value
-
getLocalProtectionDesired
Return current value associated with the property corresponding toTunnelAttributes.getLocalProtectionDesired()
.- Returns:
- current value
-
getNetworkTopologyRef
Return current value associated with the property corresponding toNetworkTopologyReference.getNetworkTopologyRef()
.- Returns:
- current value
-
getPreconditions
Return current value associated with the property corresponding toSubmitInstructionInput.getPreconditions()
.- Returns:
- current value
-
getSeStyleDesired
Return current value associated with the property corresponding toTunnelAttributes.getSeStyleDesired()
.- Returns:
- current value
-
getSessionName
Return current value associated with the property corresponding toTunnelAttributes.getSessionName()
.- Returns:
- current value
-
getSetupPriority
public org.opendaylight.yangtools.yang.common.Uint8 getSetupPriority()Return current value associated with the property corresponding toPriority.getSetupPriority()
.- Returns:
- current value
-
getSource
Return current value associated with the property corresponding toCreateP2pTunnelInput.getSource()
.- Returns:
- current value
-
getSymbolicPathName
Return current value associated with the property corresponding toTunnelPcepLinkCfgAttributes.getSymbolicPathName()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<PcepCreateP2pTunnelInput>> 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
-
setBandwidth
Set the property corresponding toTunnelPcepLinkCfgAttributes.getBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setClassType
Set the property corresponding toTunnelPcepLinkCfgAttributes.getClassType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDeadline
Set the property corresponding toSubmitInstructionInput.getDeadline()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDestination
Set the property corresponding toCreateP2pTunnelInput.getDestination()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setExcludeAny
Set the property corresponding toAttributeFilters.getExcludeAny()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setExplicitHops
Set the property corresponding toTunnelP2pPathCfgAttributes.getExplicitHops()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setHoldPriority
public PcepCreateP2pTunnelInputBuilder setHoldPriority(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toPriority.getHoldPriority()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setId
Set the property corresponding toSubmitInstructionInput.getId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIncludeAll
Set the property corresponding toAttributeFilters.getIncludeAll()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIncludeAny
Set the property corresponding toAttributeFilters.getIncludeAny()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLabelRecordingDesired
Set the property corresponding toTunnelAttributes.getLabelRecordingDesired()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocalProtectionDesired
Set the property corresponding toTunnelAttributes.getLocalProtectionDesired()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNetworkTopologyRef
Set the property corresponding toNetworkTopologyReference.getNetworkTopologyRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPreconditions
Set the property corresponding toSubmitInstructionInput.getPreconditions()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setSeStyleDesired
Set the property corresponding toTunnelAttributes.getSeStyleDesired()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSessionName
Set the property corresponding toTunnelAttributes.getSessionName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSetupPriority
public PcepCreateP2pTunnelInputBuilder setSetupPriority(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toPriority.getSetupPriority()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSource
Set the property corresponding toCreateP2pTunnelInput.getSource()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSymbolicPathName
Set the property corresponding toTunnelPcepLinkCfgAttributes.getSymbolicPathName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PcepCreateP2pTunnelInputBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<PcepCreateP2pTunnelInput> 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 PcepCreateP2pTunnelInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<PcepCreateP2pTunnelInput>> 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 newPcepCreateP2pTunnelInput
instance.- Returns:
- A new
PcepCreateP2pTunnelInput
instance.
-