Class TedBuilder


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

       
         Ted createTed(int fooXyzzy, int barBaz) {
             return new TedBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

    This pattern is supported by the immutable nature of Ted, 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:
    Ted
    • Constructor Detail

      • TedBuilder

        public TedBuilder()
        Construct an empty builder.
      • TedBuilder

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

        public TedBuilder​(Ted base)
        Construct a builder initialized with state from specified Ted.
        Parameters:
        base - Ted 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
      • getColor

        public org.opendaylight.yangtools.yang.common.Uint32 getColor()
        Return current value associated with the property corresponding to TedLinkAttributes.getColor().
        Returns:
        current value
      • getMaxLinkBandwidth

        public org.opendaylight.yangtools.yang.common.Decimal64 getMaxLinkBandwidth()
        Return current value associated with the property corresponding to TedLinkAttributes.getMaxLinkBandwidth().
        Returns:
        current value
      • getMaxResvLinkBandwidth

        public org.opendaylight.yangtools.yang.common.Decimal64 getMaxResvLinkBandwidth()
        Return current value associated with the property corresponding to TedLinkAttributes.getMaxResvLinkBandwidth().
        Returns:
        current value
      • getTeDefaultMetric

        public org.opendaylight.yangtools.yang.common.Uint32 getTeDefaultMetric()
        Return current value associated with the property corresponding to TedLinkAttributes.getTeDefaultMetric().
        Returns:
        current value
      • augmentation

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

        public TedBuilder setColor​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to TedLinkAttributes.getColor() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setMaxLinkBandwidth

        public TedBuilder setMaxLinkBandwidth​(org.opendaylight.yangtools.yang.common.Decimal64 value)
        Set the property corresponding to TedLinkAttributes.getMaxLinkBandwidth() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setMaxResvLinkBandwidth

        public TedBuilder setMaxResvLinkBandwidth​(org.opendaylight.yangtools.yang.common.Decimal64 value)
        Set the property corresponding to TedLinkAttributes.getMaxResvLinkBandwidth() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • setTeDefaultMetric

        public TedBuilder setTeDefaultMetric​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to TedLinkAttributes.getTeDefaultMetric() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder
      • addAugmentation

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