Class MeterMessageBuilder

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

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

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

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

      • MeterMessageBuilder

        public MeterMessageBuilder()
      • MeterMessageBuilder

        public MeterMessageBuilder​(Meter arg)
      • MeterMessageBuilder

        public MeterMessageBuilder​(OfHeader arg)
      • MeterMessageBuilder

        public MeterMessageBuilder​(MeterMessage 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.openflow.protocol.rev130731.OfHeader
        • org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.Meter
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getBarrier

        public Boolean getBarrier()
      • isBarrier

        public final Boolean isBarrier()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getContainerName

        public String getContainerName()
      • getMeterId

        public MeterId getMeterId()
      • getMeterName

        public String getMeterName()
      • getVersion

        public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
      • getXid

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

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

        public MeterMessageBuilder setVersion​(org.opendaylight.yangtools.yang.common.Uint8 value)
      • setXid

        public MeterMessageBuilder setXid​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setXid

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

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

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