Class ClassTypeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.classtype.object.ClassTypeBuilder
-
@Generated("mdsal-binding-generator") public class ClassTypeBuilder extends Object
Class that buildsClassType
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:
ClassType createClassType(int fooXyzzy, int barBaz) { return new ClassTypeBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ClassType, 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:
ClassType
- 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
-
-
Constructor Summary
Constructors Constructor Description ClassTypeBuilder()
Construct an empty builder.ClassTypeBuilder(ClassType base)
Construct a builder initialized with state from specifiedClassType
.ClassTypeBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.ClassTypeBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ClassTypeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ClassType> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ClassType>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ClassType
build()
A newClassType
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ClassType
getClassType()
Return current value associated with the property corresponding toClassType.getClassType()
.Boolean
getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.Boolean
getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.ClassTypeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ClassType>> augmentationType)
Remove an augmentation from this builder's product.ClassTypeBuilder
setClassType(ClassType value)
Set the property corresponding toClassType.getClassType()
to the specified value.ClassTypeBuilder
setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.ClassTypeBuilder
setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.
-
-
-
Constructor Detail
-
ClassTypeBuilder
public ClassTypeBuilder()
Construct an empty builder.
-
ClassTypeBuilder
public ClassTypeBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.- Parameters:
arg
- Object from which the builder should be initialized
-
ClassTypeBuilder
public ClassTypeBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.- Parameters:
arg
- ObjectHeader from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getClassType
public ClassType getClassType()
Return current value associated with the property corresponding toClassType.getClassType()
.- Returns:
- current value
-
getIgnore
public Boolean getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.- Returns:
- current value
-
getProcessingRule
public Boolean getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ClassType>> 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
-
setClassType
public ClassTypeBuilder setClassType(ClassType value)
Set the property corresponding toClassType.getClassType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIgnore
public ClassTypeBuilder setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProcessingRule
public ClassTypeBuilder setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ClassTypeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ClassType> 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 ClassTypeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ClassType>> 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
-
-