Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.alarms.rev190709.alarms.top.alarms

Class AlarmBuilder

  • @Generated("mdsal-binding-generator")
public class AlarmBuilder
extends Object
    Class that builds Alarm 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: 

       
     Alarm createAlarm(int fooXyzzy, int barBaz) {
         return new AlarmBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • AlarmBuilder

        public AlarmBuilder()
        Construct an empty builder.

      • AlarmBuilder

        public AlarmBuilder​(Alarm base)
        Construct a builder initialized with state from specified Alarm.
        Parameters:
        base - Alarm from which the builder should be initialized

    • Method Detail

      • key

        public AlarmKey key()
        Return current value associated with the property corresponding to Alarm.key().
        Returns:
        current value

      • getConfig

        public Config getConfig()
        Return current value associated with the property corresponding to Alarm.getConfig().
        Returns:
        current value

      • getId

        public String getId()
        Return current value associated with the property corresponding to Alarm.getId().
        Returns:
        current value

      • getState

        public State getState()
        Return current value associated with the property corresponding to Alarm.getState().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Alarm>> 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 - if augmentType is null

      • setConfig

        public AlarmBuilder setConfig​(Config value)
        Set the property corresponding to Alarm.getConfig() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setId

        public AlarmBuilder setId​(String value)
        Set the property corresponding to Alarm.getId() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setState

        public AlarmBuilder setState​(State value)
        Set the property corresponding to Alarm.getState() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

        public AlarmBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Alarm> 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 AlarmBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Alarm>> 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 @NonNull Alarm build()
        A new Alarm instance.
        Returns:
        A new Alarm instance.