Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.peers.peer
Class MirrorsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.peers.peer.MirrorsBuilder
Class that builds
Mirrors
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:
Mirrors createMirrors(int fooXyzzy, int barBaz) {
return new MirrorsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Mirrors, 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
ConstructorDescriptionConstruct an empty builder.MirrorsBuilder
(Timestamp arg) Construct a new builder initialized from specifiedTimestamp
.MirrorsBuilder
(Mirrors base) Construct a builder initialized with state from specifiedMirrors
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Mirrors> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Mirrors>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Mirrors
build()
A newMirrors
instance.static @NonNull Mirrors
empty()
Get empty instance of Mirrors.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toMirrors.getInformation()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp
Return current value associated with the property corresponding toTimestamp.getTimestampMicro()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp
Return current value associated with the property corresponding toTimestamp.getTimestampSec()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Mirrors>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toMirrors.getInformation()
to the specified value.setTimestampMicro
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value) Set the property corresponding toTimestamp.getTimestampMicro()
to the specified value.setTimestampSec
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value) Set the property corresponding toTimestamp.getTimestampSec()
to the specified value.
-
Constructor Details
-
MirrorsBuilder
public MirrorsBuilder()Construct an empty builder. -
MirrorsBuilder
Construct a new builder initialized from specifiedTimestamp
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.Timestamp from which the builder should be initialized
-
MirrorsBuilder
Construct a builder initialized with state from specifiedMirrors
.- Parameters:
base
- Mirrors from which the builder should be initialized
-
-
Method Details
-
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
-
empty
Get empty instance of Mirrors.- Returns:
- An empty
Mirrors
-
getInformation
Return current value associated with the property corresponding toMirrors.getInformation()
.- Returns:
- current value
-
getTimestampMicro
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp getTimestampMicro()Return current value associated with the property corresponding toTimestamp.getTimestampMicro()
.- Returns:
- current value
-
getTimestampSec
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp getTimestampSec()Return current value associated with the property corresponding toTimestamp.getTimestampSec()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Mirrors>> 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
-
setInformation
Set the property corresponding toMirrors.getInformation()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTimestampMicro
public MirrorsBuilder setTimestampMicro(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value) Set the property corresponding toTimestamp.getTimestampMicro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTimestampSec
public MirrorsBuilder setTimestampSec(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value) Set the property corresponding toTimestamp.getTimestampSec()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MirrorsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Mirrors> 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 MirrorsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Mirrors>> 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 newMirrors
instance.- Returns:
- A new
Mirrors
instance.
-