Class PacketsBuilder

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

    public class PacketsBuilder
    extends java.lang.Object
    implements org.opendaylight.yangtools.concepts.Builder<Packets>
    Class that builds PacketsBuilder 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:

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

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

      • PacketsBuilder

        public PacketsBuilder()
      • PacketsBuilder

        public PacketsBuilder​(Packets 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.netvirt.acl.live.statistics.rev161129.AclDropCounts
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types
      • getAntiSpoofDropCount

        public org.opendaylight.yangtools.yang.common.Uint64 getAntiSpoofDropCount()
      • getDropCount

        public org.opendaylight.yangtools.yang.common.Uint64 getDropCount()
      • getInvalidDropCount

        public org.opendaylight.yangtools.yang.common.Uint64 getInvalidDropCount()
      • getTotalDropCount

        public org.opendaylight.yangtools.yang.common.Uint64 getTotalDropCount()
      • augmentation

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

        public PacketsBuilder setAntiSpoofDropCount​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setAntiSpoofDropCount

        @Deprecated(forRemoval=true)
        public PacketsBuilder setAntiSpoofDropCount​(java.math.BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setAntiSpoofDropCount(Uint64)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • setDropCount

        public PacketsBuilder setDropCount​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setDropCount

        @Deprecated(forRemoval=true)
        public PacketsBuilder setDropCount​(java.math.BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setDropCount(Uint64)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • setInvalidDropCount

        public PacketsBuilder setInvalidDropCount​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setInvalidDropCount

        @Deprecated(forRemoval=true)
        public PacketsBuilder setInvalidDropCount​(java.math.BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setInvalidDropCount(Uint64)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • setTotalDropCount

        public PacketsBuilder setTotalDropCount​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setTotalDropCount

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

        public PacketsBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Packets>> augmentationType,
                                              org.opendaylight.yangtools.yang.binding.Augmentation<Packets> augmentationValue)
      • removeAugmentation

        public PacketsBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Packets>> augmentationType)
      • build

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