Class StaleMeterBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<StaleMeter>, org.opendaylight.yangtools.concepts.CheckedBuilder<StaleMeter,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    @Generated("mdsal-binding-generator")
    public class StaleMeterBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<StaleMeter>
    Class that builds StaleMeterBuilder 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:

       
         StaleMeterBuilder createTarget(int fooXyzzy, int barBaz) {
             return new StaleMeterBuilderBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

    This pattern is supported by the immutable nature of StaleMeterBuilder, 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 oportunities, 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:
    StaleMeterBuilder, Builder
    • Constructor Detail

      • StaleMeterBuilder

        public StaleMeterBuilder()
      • StaleMeterBuilder

        public StaleMeterBuilder​(Meter arg)
      • StaleMeterBuilder

        public StaleMeterBuilder​(StaleMeter 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:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.Meter
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getBarrier

        public Boolean getBarrier()
      • isBarrier

        @Deprecated(forRemoval=true)
        public final Boolean isBarrier()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getContainerName

        public String getContainerName()
      • getMeterId

        public MeterId getMeterId()
      • getMeterName

        public String getMeterName()
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<StaleMeter>> E$$ augmentation​(Class<E$$> augmentationType)
      • addAugmentation

        public StaleMeterBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<StaleMeter> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        NullPointerException - if augmentation is null
      • removeAugmentation

        public StaleMeterBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<StaleMeter>> 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