Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.gc.object

Class GcBuilder

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

       
     Gc createGc(int fooXyzzy, int barBaz) {
         return new GcBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • GcBuilder

        public GcBuilder()
        Construct an empty builder.

      • GcBuilder

        public GcBuilder​(Object arg)
        Construct a new builder initialized from specified Object.
        Parameters:
        arg - Object from which the builder should be initialized

      • GcBuilder

        public GcBuilder​(ObjectHeader arg)
        Construct a new builder initialized from specified ObjectHeader.
        Parameters:
        arg - ObjectHeader from which the builder should be initialized

      • GcBuilder

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

    • 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:
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getIgnore

        public Boolean getIgnore()
        Return current value associated with the property corresponding to ObjectHeader.getIgnore().
        Returns:
        current value

      • getMaxHop

        public org.opendaylight.yangtools.yang.common.Uint8 getMaxHop()
        Return current value associated with the property corresponding to Gc.getMaxHop().
        Returns:
        current value

      • getMaxUtilization

        public org.opendaylight.yangtools.yang.common.Uint8 getMaxUtilization()
        Return current value associated with the property corresponding to Gc.getMaxUtilization().
        Returns:
        current value

      • getMinUtilization

        public org.opendaylight.yangtools.yang.common.Uint8 getMinUtilization()
        Return current value associated with the property corresponding to Gc.getMinUtilization().
        Returns:
        current value

      • getOverBookingFactor

        public org.opendaylight.yangtools.yang.common.Uint8 getOverBookingFactor()
        Return current value associated with the property corresponding to Gc.getOverBookingFactor().
        Returns:
        current value

      • getTlvs

        public Tlvs getTlvs()
        Return current value associated with the property corresponding to Gc.getTlvs().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Gc>> 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

      • setMaxHop

        public GcBuilder setMaxHop​(org.opendaylight.yangtools.yang.common.Uint8 value)
        Set the property corresponding to Gc.getMaxHop() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setMaxUtilization

        public GcBuilder setMaxUtilization​(org.opendaylight.yangtools.yang.common.Uint8 value)
        Set the property corresponding to Gc.getMaxUtilization() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setMinUtilization

        public GcBuilder setMinUtilization​(org.opendaylight.yangtools.yang.common.Uint8 value)
        Set the property corresponding to Gc.getMinUtilization() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setOverBookingFactor

        public GcBuilder setOverBookingFactor​(org.opendaylight.yangtools.yang.common.Uint8 value)
        Set the property corresponding to Gc.getOverBookingFactor() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setTlvs

        public GcBuilder setTlvs​(Tlvs value)
        Set the property corresponding to Gc.getTlvs() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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