Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.port.mod.port

Class PortBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Port>, org.opendaylight.yangtools.concepts.CheckedBuilder<Port,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class PortBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Port>
    Class that builds PortBuilder 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: 

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

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

    • Constructor Detail

      • PortBuilder

        public PortBuilder()

      • PortBuilder

        public PortBuilder​(CommonPort arg)

      • PortBuilder

        public PortBuilder​(Port 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.flow.types.port.rev130925.CommonPortWithMask
        • org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.CommonPort
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getAdvertisedFeatures

        public PortFeatures getAdvertisedFeatures()

      • getBarrier

        public Boolean getBarrier()

      • isBarrier

        @Deprecated(forRemoval=true)
public final Boolean isBarrier()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getConfiguration

        public PortConfig getConfiguration()

      • getContainerName

        public String getContainerName()

      • getHardwareAddress

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

      • getPortModOrder

        public org.opendaylight.yangtools.yang.common.Uint32 getPortModOrder()

      • getPortName

        public String getPortName()

      • augmentation

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

      • setHardwareAddress

        public PortBuilder setHardwareAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)

      • setPortModOrder

        public PortBuilder setPortModOrder​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setPortModOrder

        @Deprecated(forRemoval=true)
public PortBuilder setPortModOrder​(Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setPortModOrder(Uint32) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • addAugmentation

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

      • removeAugmentation

        public PortBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Port>> 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 Port build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Port>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Port,​IllegalArgumentException>