Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.platform.component.memory.state

Class MemoryBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Memory>, org.opendaylight.yangtools.concepts.CheckedBuilder<Memory,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class MemoryBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Memory>
    Class that builds MemoryBuilder 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: 

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

    This pattern is supported by the immutable nature of MemoryBuilder, 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:
    MemoryBuilder, Builder

    • Constructor Detail

      • MemoryBuilder

        public MemoryBuilder()

      • MemoryBuilder

        public MemoryBuilder​(Memory base)

    • Method Detail

      • getAvailable

        public org.opendaylight.yangtools.yang.common.Uint64 getAvailable()

      • getUtilized

        public org.opendaylight.yangtools.yang.common.Uint64 getUtilized()

      • augmentation

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

      • setAvailable

        public MemoryBuilder setAvailable​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setUtilized

        public MemoryBuilder setUtilized​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • addAugmentation

        public MemoryBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Memory> 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 MemoryBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Memory>> 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 Memory build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Memory>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Memory,​IllegalArgumentException>