Class PktMarkValuesBuilder

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

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

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

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

      • PktMarkValuesBuilder

        public PktMarkValuesBuilder()
      • PktMarkValuesBuilder

        public PktMarkValuesBuilder​(PktMarkValues base)
    • Method Detail

      • getMask

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

        public org.opendaylight.yangtools.yang.common.Uint32 getPktMark()
      • augmentation

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

        public PktMarkValuesBuilder setMask​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setMask

        public PktMarkValuesBuilder setMask​(Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setMask(Uint32) instead.
        Utility migration setter.
        value - field value in legacy type
        this builder
      • setPktMark

        public PktMarkValuesBuilder setPktMark​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • addAugmentation

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

        public PktMarkValuesBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PktMarkValues>> 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