Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.interfaces.top.interfaces._interface

Class StateBuilder

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

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

    This pattern is supported by the immutable nature of StateBuilder, 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:
    StateBuilder, 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:
        • org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.InterfaceCommonConfig
        • org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.InterfaceCountersState
        • org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.InterfaceCommonState
        • org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.InterfacePhysConfig
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getCounters

        public Counters getCounters()

      • getDescription

        public String getDescription()

      • getEnabled

        public Boolean getEnabled()

      • isEnabled

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

      • getIfindex

        public org.opendaylight.yangtools.yang.common.Uint32 getIfindex()

      • getLastChange

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks getLastChange()

      • getMtu

        public org.opendaylight.yangtools.yang.common.Uint16 getMtu()

      • getName

        public String getName()

      • getType

        public Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> getType()

      • augmentation

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

      • setIfindex

        public StateBuilder setIfindex​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setIfindex

        @Deprecated(forRemoval=true)
public StateBuilder setIfindex​(Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setIfindex(Uint32) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setLastChange

        public StateBuilder setLastChange​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks value)

      • setMtu

        public StateBuilder setMtu​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setMtu

        @Deprecated(forRemoval=true)
public StateBuilder setMtu​(Integer value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setMtu(Uint16) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setType

        public StateBuilder setType​(Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> value)

      • addAugmentation

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