Class ProcessBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.procmon.rev190315.procmon.processes.top.processes.ProcessBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Process>,org.opendaylight.yangtools.concepts.CheckedBuilder<Process,IllegalArgumentException>,org.opendaylight.yangtools.concepts.Mutable,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ProcessBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Process>
Class that buildsProcessinstances. 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:
Process createProcess(int fooXyzzy, int barBaz) { return new ProcessBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }This pattern is supported by the immutable nature of Process, 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:
Process,Builder
-
-
Constructor Summary
Constructors Constructor Description ProcessBuilder()ProcessBuilder(Process base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ProcessBuilderaddAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Process> augmentation)Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Process>>
E$$augmentation(Class<E$$> augmentationType)Processbuild()org.opendaylight.yangtools.yang.common.Uint64getPid()StategetState()ProcessKeykey()ProcessBuilderremoveAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Process>> augmentationType)Remove an augmentation from this builder's product.ProcessBuildersetPid(org.opendaylight.yangtools.yang.common.Uint64 value)ProcessBuildersetState(State value)ProcessBuilderwithKey(ProcessKey key)
-
-
-
Constructor Detail
-
ProcessBuilder
public ProcessBuilder()
-
ProcessBuilder
public ProcessBuilder(Process base)
-
-
Method Detail
-
key
public ProcessKey key()
-
getPid
public org.opendaylight.yangtools.yang.common.Uint64 getPid()
-
getState
public State getState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Process>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public ProcessBuilder withKey(ProcessKey key)
-
setPid
public ProcessBuilder setPid(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setState
public ProcessBuilder setState(State value)
-
addAugmentation
public ProcessBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Process> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException- ifaugmentationis null
-
removeAugmentation
public ProcessBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Process>> 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 Process build()
- Specified by:
buildin interfaceorg.opendaylight.yangtools.concepts.Builder<Process>- Specified by:
buildin interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Process,IllegalArgumentException>
-
-