Class PcepUpdateTunnelInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev181109.PcepUpdateTunnelInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PcepUpdateTunnelInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PcepUpdateTunnelInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PcepUpdateTunnelInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PcepUpdateTunnelInput>
Class that buildsPcepUpdateTunnelInput
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:
PcepUpdateTunnelInput createPcepUpdateTunnelInput(int fooXyzzy, int barBaz) { return new PcepUpdateTunnelInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PcepUpdateTunnelInput, 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:
PcepUpdateTunnelInput
,Builder
-
-
Constructor Summary
-
Method Summary
-
-
-
Constructor Detail
-
PcepUpdateTunnelInputBuilder
public PcepUpdateTunnelInputBuilder()
-
PcepUpdateTunnelInputBuilder
public PcepUpdateTunnelInputBuilder(BaseTunnelInput arg)
-
PcepUpdateTunnelInputBuilder
public PcepUpdateTunnelInputBuilder(TopologyInstructionInput arg)
-
PcepUpdateTunnelInputBuilder
public PcepUpdateTunnelInputBuilder(SubmitInstructionInput arg)
-
PcepUpdateTunnelInputBuilder
public PcepUpdateTunnelInputBuilder(NetworkTopologyReference arg)
-
PcepUpdateTunnelInputBuilder
public PcepUpdateTunnelInputBuilder(TunnelP2pPathCfgAttributes arg)
-
PcepUpdateTunnelInputBuilder
public PcepUpdateTunnelInputBuilder(TunnelPcepLinkCfgAttributes arg)
-
PcepUpdateTunnelInputBuilder
public PcepUpdateTunnelInputBuilder(TunnelAttributes arg)
-
PcepUpdateTunnelInputBuilder
public PcepUpdateTunnelInputBuilder(Priority arg)
-
PcepUpdateTunnelInputBuilder
public PcepUpdateTunnelInputBuilder(AttributeFilters arg)
-
PcepUpdateTunnelInputBuilder
public PcepUpdateTunnelInputBuilder(PcepUpdateTunnelInput 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:- TopologyInstructionInput
- SubmitInstructionInput
- TunnelP2pPathCfgAttributes
- Priority
- AttributeFilters
- NetworkTopologyReference
- TunnelPcepLinkCfgAttributes
- BaseTunnelInput
- TunnelAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBandwidth
public Bandwidth getBandwidth()
-
getClassType
public ClassType getClassType()
-
getDeadline
public Nanotime getDeadline()
-
getExcludeAny
public AttributeFilter getExcludeAny()
-
getExplicitHops
public Map<ExplicitHopsKey,ExplicitHops> getExplicitHops()
-
getHoldPriority
public org.opendaylight.yangtools.yang.common.Uint8 getHoldPriority()
-
getId
public InstructionId getId()
-
getIncludeAll
public AttributeFilter getIncludeAll()
-
getIncludeAny
public AttributeFilter getIncludeAny()
-
getLabelRecordingDesired
public Boolean getLabelRecordingDesired()
-
getLinkId
public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId getLinkId()
-
getLocalProtectionDesired
public Boolean getLocalProtectionDesired()
-
getNetworkTopologyRef
public NetworkTopologyRef getNetworkTopologyRef()
-
getPreconditions
public List<InstructionId> getPreconditions()
-
getSeStyleDesired
public Boolean getSeStyleDesired()
-
getSessionName
public String getSessionName()
-
getSetupPriority
public org.opendaylight.yangtools.yang.common.Uint8 getSetupPriority()
-
getSymbolicPathName
public String getSymbolicPathName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepUpdateTunnelInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setBandwidth
public PcepUpdateTunnelInputBuilder setBandwidth(Bandwidth value)
-
setClassType
public PcepUpdateTunnelInputBuilder setClassType(ClassType value)
-
setDeadline
public PcepUpdateTunnelInputBuilder setDeadline(Nanotime value)
-
setExcludeAny
public PcepUpdateTunnelInputBuilder setExcludeAny(AttributeFilter value)
-
setExplicitHops
public PcepUpdateTunnelInputBuilder setExplicitHops(Map<ExplicitHopsKey,ExplicitHops> values)
-
setHoldPriority
public PcepUpdateTunnelInputBuilder setHoldPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setId
public PcepUpdateTunnelInputBuilder setId(InstructionId value)
-
setIncludeAll
public PcepUpdateTunnelInputBuilder setIncludeAll(AttributeFilter value)
-
setIncludeAny
public PcepUpdateTunnelInputBuilder setIncludeAny(AttributeFilter value)
-
setLabelRecordingDesired
public PcepUpdateTunnelInputBuilder setLabelRecordingDesired(Boolean value)
-
setLinkId
public PcepUpdateTunnelInputBuilder setLinkId(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId value)
-
setLocalProtectionDesired
public PcepUpdateTunnelInputBuilder setLocalProtectionDesired(Boolean value)
-
setNetworkTopologyRef
public PcepUpdateTunnelInputBuilder setNetworkTopologyRef(NetworkTopologyRef value)
-
setPreconditions
public PcepUpdateTunnelInputBuilder setPreconditions(List<InstructionId> values)
-
setSeStyleDesired
public PcepUpdateTunnelInputBuilder setSeStyleDesired(Boolean value)
-
setSessionName
public PcepUpdateTunnelInputBuilder setSessionName(String value)
-
setSetupPriority
public PcepUpdateTunnelInputBuilder setSetupPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setSymbolicPathName
public PcepUpdateTunnelInputBuilder setSymbolicPathName(String value)
-
addAugmentation
public PcepUpdateTunnelInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcepUpdateTunnelInput> 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 PcepUpdateTunnelInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepUpdateTunnelInput>> 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 PcepUpdateTunnelInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PcepUpdateTunnelInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PcepUpdateTunnelInput,IllegalArgumentException>
-
-