Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces._interface

Class GreBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Gre>, org.opendaylight.yangtools.concepts.CheckedBuilder<Gre,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class GreBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<Gre>
    Class that builds GreBuilder 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: 

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

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

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      GreBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Gre>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Gre> augmentationValue)  
      <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Gre>>
      E$$      		 augmentation​(java.lang.Class<E$$> augmentationType)  
      Gre build()  
      void fieldsFrom​(org.opendaylight.yangtools.yang.binding.DataObject arg)
      Set fields from given grouping argument.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getDst()  
      org.opendaylight.yangtools.yang.common.Uint32 getOuterFibId()  
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getSrc()  
      GreBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Gre>> augmentationType)  
      GreBuilder setDst​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)  
      GreBuilder setOuterFibId​(java.lang.Long value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use {#link setOuterFibId(Uint32)} instead.
      GreBuilder setOuterFibId​(org.opendaylight.yangtools.yang.common.Uint32 value)  
      GreBuilder setSrc​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • GreBuilder

        public GreBuilder()

      • GreBuilder

        public GreBuilder​(Gre base)

    • 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.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.GreBaseAttributes
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getDst

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getDst()

      • getOuterFibId

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

      • getSrc

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getSrc()

      • augmentation

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

      • setDst

        public GreBuilder setDst​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)

      • setOuterFibId

        public GreBuilder setOuterFibId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setOuterFibId

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

      • setSrc

        public GreBuilder setSrc​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)

      • addAugmentation

        public GreBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Gre>> augmentationType,
                                  org.opendaylight.yangtools.yang.binding.Augmentation<Gre> augmentationValue)

      • removeAugmentation

        public GreBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Gre>> augmentationType)

      • build

        public Gre build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Gre>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Gre,​java.lang.IllegalArgumentException>