Class AceEthBuilder

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

    @Generated("mdsal-binding-generator")
    public class AceEthBuilder
    extends java.lang.Object
    implements org.opendaylight.yangtools.concepts.Builder<AceEth>
    Class that builds AceEthBuilder 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:

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

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

      • AceEthBuilder

        public AceEthBuilder()
      • AceEthBuilder

        public AceEthBuilder​(AceEth 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.ietf.params.xml.ns.yang.ietf.packet.fields.rev160218.AclEthHeaderFields
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getDestinationMacAddress

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getDestinationMacAddress()
      • getDestinationMacAddressMask

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getDestinationMacAddressMask()
      • getSourceMacAddress

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getSourceMacAddress()
      • getSourceMacAddressMask

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getSourceMacAddressMask()
      • augmentation

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

        public AceEthBuilder setDestinationMacAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
      • setDestinationMacAddressMask

        public AceEthBuilder setDestinationMacAddressMask​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
      • setSourceMacAddress

        public AceEthBuilder setSourceMacAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
      • setSourceMacAddressMask

        public AceEthBuilder setSourceMacAddressMask​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
      • addAugmentation

        public AceEthBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<AceEth> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        java.lang.NullPointerException - if augmentation is null
      • removeAugmentation

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

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