Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.sfc.flow.classifier.rev160511.sfc.flow.classifiers.attributes.sfc.flow.classifiers

Class SfcFlowClassifierBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<SfcFlowClassifier>, org.opendaylight.yangtools.concepts.CheckedBuilder<SfcFlowClassifier,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class SfcFlowClassifierBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<SfcFlowClassifier>
    Class that builds SfcFlowClassifierBuilder 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: 

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

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

    • Constructor Detail

      • SfcFlowClassifierBuilder

        public SfcFlowClassifierBuilder()

      • SfcFlowClassifierBuilder

        public SfcFlowClassifierBuilder​(BaseAttributes arg)

      • SfcFlowClassifierBuilder

        public SfcFlowClassifierBuilder​(IdAttributes arg)

      • SfcFlowClassifierBuilder

        public SfcFlowClassifierBuilder​(SfcFlowClassifier 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.neutron.attrs.rev150712.IdAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.BaseAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.sfc.flow.classifier.rev160511.FlowClassifierMatchAttributes
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getDestinationIpPrefix

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getDestinationIpPrefix()

      • getDestinationPortRangeMax

        public org.opendaylight.yangtools.yang.common.Uint16 getDestinationPortRangeMax()

      • getDestinationPortRangeMin

        public org.opendaylight.yangtools.yang.common.Uint16 getDestinationPortRangeMin()

      • getLogicalDestinationPort

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

      • getLogicalSourcePort

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

      • getName

        public String getName()

      • getProjectId

        public String getProjectId()

      • getRevisionNumber

        public Long getRevisionNumber()

      • getSourceIpPrefix

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getSourceIpPrefix()

      • getSourcePortRangeMax

        public org.opendaylight.yangtools.yang.common.Uint16 getSourcePortRangeMax()

      • getSourcePortRangeMin

        public org.opendaylight.yangtools.yang.common.Uint16 getSourcePortRangeMin()

      • getTenantId

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

      • getUuid

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

      • augmentation

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

      • setDestinationIpPrefix

        public SfcFlowClassifierBuilder setDestinationIpPrefix​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)

      • setDestinationPortRangeMax

        public SfcFlowClassifierBuilder setDestinationPortRangeMax​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setDestinationPortRangeMin

        public SfcFlowClassifierBuilder setDestinationPortRangeMin​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setL7Parameter

        @Deprecated(forRemoval=true)
public SfcFlowClassifierBuilder setL7Parameter​(List<L7Parameter> values)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setL7Parameter(Map) instead.
        Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.
        Parameters:
        values - Legacy List of values
        Returns:
        this builder
        Throws:
        IllegalArgumentException - if the list contains entries with the same key
        NullPointerException - if the list contains a null entry

      • setLogicalDestinationPort

        public SfcFlowClassifierBuilder setLogicalDestinationPort​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setLogicalSourcePort

        public SfcFlowClassifierBuilder setLogicalSourcePort​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setSourceIpPrefix

        public SfcFlowClassifierBuilder setSourceIpPrefix​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)

      • setSourcePortRangeMax

        public SfcFlowClassifierBuilder setSourcePortRangeMax​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setSourcePortRangeMin

        public SfcFlowClassifierBuilder setSourcePortRangeMin​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setTenantId

        public SfcFlowClassifierBuilder setTenantId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setUuid

        public SfcFlowClassifierBuilder setUuid​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • addAugmentation

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

      • addAugmentation

        @Deprecated(forRemoval=true)
public SfcFlowClassifierBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SfcFlowClassifier>> augmentationType,
                                                org.opendaylight.yangtools.yang.binding.Augmentation<SfcFlowClassifier> augmentationValue)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use either addAugmentation(Augmentation) or removeAugmentation(Class) instead.
        Add or remove an augmentation to this builder's product.
        Parameters:
        augmentationType - augmentation type to be added or removed
        augmentationValue - augmentation value, null if the augmentation type should be removed
        Returns:
        this builder

      • removeAugmentation

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