Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.table.features._case.multipart.request.table.features

Class TableFeaturesBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.table.features._case.multipart.request.table.features.TableFeaturesBuilder
@Generated("mdsal-binding-generator") public class TableFeaturesBuilder extends Object
Class that builds TableFeatures 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: 

   
     TableFeatures createTableFeatures(int fooXyzzy, int barBaz) {
         return new TableFeaturesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

  • Constructor Details

    • TableFeaturesBuilder

      public TableFeaturesBuilder()
      Construct an empty builder.

    • TableFeaturesBuilder

      public TableFeaturesBuilder(TableFeaturesPropertiesGrouping arg)
      Construct a new builder initialized from specified TableFeaturesPropertiesGrouping.
      Parameters:
      arg - TableFeaturesPropertiesGrouping from which the builder should be initialized

    • TableFeaturesBuilder

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

  • Method Details

    • 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

    • getConfig

      public TableConfig getConfig()
      Return current value associated with the property corresponding to TableFeatures.getConfig().
      Returns:
      current value

    • getMaxEntries

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

    • getMetadataMatch

      public org.opendaylight.yangtools.yang.common.Uint64 getMetadataMatch()
      Return current value associated with the property corresponding to TableFeatures.getMetadataMatch().
      Returns:
      current value

    • getMetadataWrite

      public org.opendaylight.yangtools.yang.common.Uint64 getMetadataWrite()
      Return current value associated with the property corresponding to TableFeatures.getMetadataWrite().
      Returns:
      current value

    • getName

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

    • getTableFeatureProperties

      public List<TableFeatureProperties> getTableFeatureProperties()
      Return current value associated with the property corresponding to TableFeaturesPropertiesGrouping.getTableFeatureProperties().
      Returns:
      current value

    • getTableId

      public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
      Return current value associated with the property corresponding to TableFeatures.getTableId().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures>> 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

    • setConfig

      public TableFeaturesBuilder setConfig(TableConfig value)
      Set the property corresponding to TableFeatures.getConfig() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMaxEntries

      public TableFeaturesBuilder setMaxEntries(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to TableFeatures.getMaxEntries() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMetadataMatch

      public TableFeaturesBuilder setMetadataMatch(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to TableFeatures.getMetadataMatch() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMetadataWrite

      public TableFeaturesBuilder setMetadataWrite(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to TableFeatures.getMetadataWrite() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setName

      public TableFeaturesBuilder setName(String value)
      Set the property corresponding to TableFeatures.getName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTableFeatureProperties

      public TableFeaturesBuilder setTableFeatureProperties(List<TableFeatureProperties> values)
      Set the property corresponding to TableFeaturesPropertiesGrouping.getTableFeatureProperties() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setTableId

      public TableFeaturesBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to TableFeatures.getTableId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public TableFeaturesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures> 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 TableFeaturesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TableFeatures>> 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 TableFeatures build()
      A new TableFeatures instance.
      Returns:
      A new TableFeatures instance.