Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.rev200413.system.top

Class SystemBuilder

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

       
     System createSystem(int fooXyzzy, int barBaz) {
         return new SystemBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • 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:
        • SystemSshServerTop
        • MessagesTop
        • SystemDnsTop
        • SystemMemoryTop
        • SystemCpuTop
        • LoggingTop
        • SystemTelnetServerTop
        • AlarmsTop
        • ProcmonProcessesTop
        • SystemClockTop
        • SystemNtpTop
        • AaaTop
        • LicenseTop
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getAaa

        public Aaa getAaa()

      • getAlarms

        public Alarms getAlarms()

      • getClock

        public Clock getClock()

      • getConfig

        public Config getConfig()

      • getCpus

        public Cpus getCpus()

      • getDns

        public Dns getDns()

      • getLicense

        public License getLicense()

      • getLogging

        public Logging getLogging()

      • getMemory

        public Memory getMemory()

      • getMessages

        public Messages getMessages()

      • getNtp

        public Ntp getNtp()

      • getProcesses

        public Processes getProcesses()

      • getSshServer

        public SshServer getSshServer()

      • getState

        public State getState()

      • augmentation

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

      • addAugmentation

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