Class BytesBuilder

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

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

         BytesBuilder createTarget(int fooXyzzy, int barBaz) {
             return new BytesBuilderBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • BytesBuilder

        public BytesBuilder()
      • BytesBuilder

        public BytesBuilder​(Bytes base)
    • Method Detail

      • getReceived

        public org.opendaylight.yangtools.yang.common.Uint64 getReceived()
      • getTransmitted

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

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

        public BytesBuilder setReceived​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setReceived

        public BytesBuilder setReceived​(BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setReceived(Uint64) instead.
        Utility migration setter.
        value - field value in legacy type
        this builder
      • setTransmitted

        public BytesBuilder setTransmitted​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • addAugmentation

        public BytesBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Bytes> augmentation)
        Add an augmentation to this builder's product.
        augmentation - augmentation to be added
        this builder
        NullPointerException - if augmentation is null
      • removeAugmentation

        public BytesBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bytes>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        augmentationType - augmentation type to be removed
        this builder
      • build

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