Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container

Class EidBuilder

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

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

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      EidBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Eid>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Eid> augmentationValue)  
      <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Eid>>
      E$$      		 augmentation​(java.lang.Class<E$$> augmentationType)  
      Eid 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.lisp.address.types.rev151105.lisp.address.Address getAddress()  
      java.lang.Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.LispAddressFamily> getAddressType()  
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.InstanceIdType getVirtualNetworkId()  
      EidBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Eid>> augmentationType)  
      EidBuilder setAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.Address value)  
      EidBuilder setAddressType​(java.lang.Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.LispAddressFamily> value)  
      EidBuilder setVirtualNetworkId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.InstanceIdType value)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • EidBuilder

        public EidBuilder()

      • EidBuilder

        public EidBuilder​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.LispAddress arg)

      • EidBuilder

        public EidBuilder​(Eid 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.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.LispAddress
        • org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.AugmentedLispAddress
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getAddress

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.Address getAddress()

      • getAddressType

        public java.lang.Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.LispAddressFamily> getAddressType()

      • getVirtualNetworkId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.InstanceIdType getVirtualNetworkId()

      • augmentation

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

      • setAddress

        public EidBuilder setAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.Address value)

      • setAddressType

        public EidBuilder setAddressType​(java.lang.Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.LispAddressFamily> value)

      • setVirtualNetworkId

        public EidBuilder setVirtualNetworkId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.InstanceIdType value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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