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

Class PortBuilder

  • @Generated("mdsal-binding-generator")
public class PortBuilder
extends Object
    Class that builds Port 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: 

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

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

    • Constructor Detail

      • PortBuilder

        public PortBuilder()
        Construct an empty builder.

      • PortBuilder

        public PortBuilder​(CommonPortWithMask arg)
        Construct a new builder initialized from specified CommonPortWithMask.
        Parameters:
        arg - CommonPortWithMask from which the builder should be initialized

      • PortBuilder

        public PortBuilder​(CommonPort arg)
        Construct a new builder initialized from specified CommonPort.
        Parameters:
        arg - CommonPort from which the builder should be initialized

      • PortBuilder

        public PortBuilder​(Port base)
        Construct a builder initialized with state from specified Port.
        Parameters:
        base - Port from which the builder should be initialized

    • 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:
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • key

        public PortKey key()
        Return current value associated with the property corresponding to Port.key().
        Returns:
        current value

      • getBarrier

        public Boolean getBarrier()
        Return current value associated with the property corresponding to Port.getBarrier().
        Returns:
        current value

      • getContainerName

        public String getContainerName()
        Return current value associated with the property corresponding to Port.getContainerName().
        Returns:
        current value

      • getHardwareAddress

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getHardwareAddress()
        Return current value associated with the property corresponding to CommonPort.getHardwareAddress().
        Returns:
        current value

      • getPortModOrder

        public org.opendaylight.yangtools.yang.common.Uint32 getPortModOrder()
        Return current value associated with the property corresponding to Port.getPortModOrder().
        Returns:
        current value

      • getPortName

        public String getPortName()
        Return current value associated with the property corresponding to Port.getPortName().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Port>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        Parameters:
        augmentationType - augmentation type class
        Returns:
        Augmentation object from this builder, or null if not present
        Throws:
        NullPointerException - if augmentType is null

      • setBarrier

        public PortBuilder setBarrier​(Boolean value)
        Set the property corresponding to Port.getBarrier() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setContainerName

        public PortBuilder setContainerName​(String value)
        Set the property corresponding to Port.getContainerName() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setHardwareAddress

        public PortBuilder setHardwareAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
        Set the property corresponding to CommonPort.getHardwareAddress() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setPortModOrder

        public PortBuilder setPortModOrder​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to Port.getPortModOrder() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setPortName

        public PortBuilder setPortName​(String value)
        Set the property corresponding to Port.getPortName() to the specified value.
        Parameters:
        value - desired value
        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 @NonNull Port build()
        A new Port instance.
        Returns:
        A new Port instance.