Class PbbIsidBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<PbbIsid>, org.opendaylight.yangtools.concepts.CheckedBuilder<PbbIsid,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    public class PbbIsidBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<PbbIsid>
    Class that builds PbbIsidBuilder 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:

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

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

      • PbbIsidBuilder

        public PbbIsidBuilder()
      • PbbIsidBuilder

        public PbbIsidBuilder​(PbbIsid base)
    • Method Detail

      • getIsid

        public org.opendaylight.yangtools.yang.common.Uint32 getIsid()
      • getMask

        public byte[] getMask()
      • augmentation

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

        public PbbIsidBuilder setIsid​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setIsid

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

        public PbbIsidBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PbbIsid>> augmentationType,
                                              org.opendaylight.yangtools.yang.binding.Augmentation<PbbIsid> augmentationValue)
      • removeAugmentation

        public PbbIsidBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PbbIsid>> augmentationType)
      • build

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