Class PortsBuilder

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

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

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

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

      • PortsBuilder

        public PortsBuilder()
      • PortsBuilder

        public PortsBuilder​(Ports 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.PortGrouping
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getAdvertisedFeatures

        public PortFeatures getAdvertisedFeatures()
      • getAdvertisedFeaturesV10

        public PortFeaturesV10 getAdvertisedFeaturesV10()
      • getCurrSpeed

        public org.opendaylight.yangtools.yang.common.Uint32 getCurrSpeed()
      • getCurrentFeatures

        public PortFeatures getCurrentFeatures()
      • getHwAddr

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

        public org.opendaylight.yangtools.yang.common.Uint32 getMaxSpeed()
      • getName

        public String getName()
      • getPortNo

        public org.opendaylight.yangtools.yang.common.Uint32 getPortNo()
      • getSupportedFeatures

        public PortFeatures getSupportedFeatures()
      • getSupportedFeaturesV10

        public PortFeaturesV10 getSupportedFeaturesV10()
      • augmentation

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

        public PortsBuilder setCurrSpeed​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setCurrSpeed

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

        public PortsBuilder setHwAddr​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
      • setMaxSpeed

        public PortsBuilder setMaxSpeed​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setMaxSpeed

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

        public PortsBuilder setPortNo​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setPortNo

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

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