Class CountersBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.ethernet.rev210609.ethernet._interface.state.CountersBuilder
Class that builds
Counters 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:
Counters createCounters(int fooXyzzy, int barBaz) {
return new CountersBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Counters, 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.CountersBuilder(Counters base) Construct a builder initialized with state from specifiedCounters.Construct a new builder initialized from specifiedEthernetInterfaceStateCounters. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Counters> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Counters>>
E$$augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Countersbuild()A newCountersinstance.static @NonNull Countersempty()Get empty instance of Counters.voidfieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getIn8021qFrames().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInBlockErrors().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInCarrierErrors().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInCrcErrors().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInFragmentFrames().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInInterruptedTx().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInJabberFrames().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInLateCollision().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInMacControlFrames().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInMacErrorsRx().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInMacPauseFrames().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInMaxsizeExceeded().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInOversizeFrames().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInSingleCollision().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInSymbolError().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInUndersizeFrames().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getOut8021qFrames().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getOutMacControlFrames().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getOutMacErrorsTx().Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getOutMacPauseFrames().removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Counters>> augmentationType) Remove an augmentation from this builder's product.setIn8021qFrames(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getIn8021qFrames()to the specified value.setInBlockErrors(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getInBlockErrors()to the specified value.setInCarrierErrors(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getInCarrierErrors()to the specified value.setInCrcErrors(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getInCrcErrors()to the specified value.setInFragmentFrames(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getInFragmentFrames()to the specified value.setInInterruptedTx(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getInInterruptedTx()to the specified value.setInJabberFrames(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getInJabberFrames()to the specified value.setInLateCollision(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getInLateCollision()to the specified value.setInMacControlFrames(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getInMacControlFrames()to the specified value.setInMacErrorsRx(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getInMacErrorsRx()to the specified value.setInMacPauseFrames(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getInMacPauseFrames()to the specified value.setInMaxsizeExceeded(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getInMaxsizeExceeded()to the specified value.setInOversizeFrames(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getInOversizeFrames()to the specified value.setInSingleCollision(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getInSingleCollision()to the specified value.setInSymbolError(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getInSymbolError()to the specified value.setInUndersizeFrames(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getInUndersizeFrames()to the specified value.setOut8021qFrames(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getOut8021qFrames()to the specified value.setOutMacControlFrames(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getOutMacControlFrames()to the specified value.setOutMacErrorsTx(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getOutMacErrorsTx()to the specified value.setOutMacPauseFrames(Counter64 value) Set the property corresponding toEthernetInterfaceStateCounters.getOutMacPauseFrames()to the specified value.
-
Constructor Details
-
CountersBuilder
public CountersBuilder()Construct an empty builder. -
CountersBuilder
Construct a new builder initialized from specifiedEthernetInterfaceStateCounters.- Parameters:
arg- EthernetInterfaceStateCounters from which the builder should be initialized
-
CountersBuilder
Construct a builder initialized with state from specifiedCounters.- Parameters:
base- Counters 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 Counters.- Returns:
- An empty
Counters
-
getIn8021qFrames
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getIn8021qFrames().- Returns:
- current value
-
getInBlockErrors
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInBlockErrors().- Returns:
- current value
-
getInCarrierErrors
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInCarrierErrors().- Returns:
- current value
-
getInCrcErrors
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInCrcErrors().- Returns:
- current value
-
getInFragmentFrames
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInFragmentFrames().- Returns:
- current value
-
getInInterruptedTx
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInInterruptedTx().- Returns:
- current value
-
getInJabberFrames
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInJabberFrames().- Returns:
- current value
-
getInLateCollision
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInLateCollision().- Returns:
- current value
-
getInMacControlFrames
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInMacControlFrames().- Returns:
- current value
-
getInMacErrorsRx
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInMacErrorsRx().- Returns:
- current value
-
getInMacPauseFrames
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInMacPauseFrames().- Returns:
- current value
-
getInMaxsizeExceeded
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInMaxsizeExceeded().- Returns:
- current value
-
getInOversizeFrames
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInOversizeFrames().- Returns:
- current value
-
getInSingleCollision
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInSingleCollision().- Returns:
- current value
-
getInSymbolError
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInSymbolError().- Returns:
- current value
-
getInUndersizeFrames
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getInUndersizeFrames().- Returns:
- current value
-
getOut8021qFrames
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getOut8021qFrames().- Returns:
- current value
-
getOutMacControlFrames
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getOutMacControlFrames().- Returns:
- current value
-
getOutMacErrorsTx
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getOutMacErrorsTx().- Returns:
- current value
-
getOutMacPauseFrames
Return current value associated with the property corresponding toEthernetInterfaceStateCounters.getOutMacPauseFrames().- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Counters>> 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
nullif not present - Throws:
NullPointerException- ifaugmentTypeisnull
-
setIn8021qFrames
Set the property corresponding toEthernetInterfaceStateCounters.getIn8021qFrames()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInBlockErrors
Set the property corresponding toEthernetInterfaceStateCounters.getInBlockErrors()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInCarrierErrors
Set the property corresponding toEthernetInterfaceStateCounters.getInCarrierErrors()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInCrcErrors
Set the property corresponding toEthernetInterfaceStateCounters.getInCrcErrors()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInFragmentFrames
Set the property corresponding toEthernetInterfaceStateCounters.getInFragmentFrames()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInInterruptedTx
Set the property corresponding toEthernetInterfaceStateCounters.getInInterruptedTx()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInJabberFrames
Set the property corresponding toEthernetInterfaceStateCounters.getInJabberFrames()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInLateCollision
Set the property corresponding toEthernetInterfaceStateCounters.getInLateCollision()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInMacControlFrames
Set the property corresponding toEthernetInterfaceStateCounters.getInMacControlFrames()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInMacErrorsRx
Set the property corresponding toEthernetInterfaceStateCounters.getInMacErrorsRx()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInMacPauseFrames
Set the property corresponding toEthernetInterfaceStateCounters.getInMacPauseFrames()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInMaxsizeExceeded
Set the property corresponding toEthernetInterfaceStateCounters.getInMaxsizeExceeded()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInOversizeFrames
Set the property corresponding toEthernetInterfaceStateCounters.getInOversizeFrames()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInSingleCollision
Set the property corresponding toEthernetInterfaceStateCounters.getInSingleCollision()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInSymbolError
Set the property corresponding toEthernetInterfaceStateCounters.getInSymbolError()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInUndersizeFrames
Set the property corresponding toEthernetInterfaceStateCounters.getInUndersizeFrames()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setOut8021qFrames
Set the property corresponding toEthernetInterfaceStateCounters.getOut8021qFrames()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setOutMacControlFrames
Set the property corresponding toEthernetInterfaceStateCounters.getOutMacControlFrames()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setOutMacErrorsTx
Set the property corresponding toEthernetInterfaceStateCounters.getOutMacErrorsTx()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setOutMacPauseFrames
Set the property corresponding toEthernetInterfaceStateCounters.getOutMacPauseFrames()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
addAugmentation
public CountersBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Counters> augmentation) Add an augmentation to this builder's product.- Parameters:
augmentation- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException- ifaugmentationis null
-
removeAugmentation
public CountersBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Counters>> 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 newCountersinstance.- Returns:
- A new
Countersinstance.
-