Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.platform.component.properties.top.properties

Class PropertyBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.platform.component.properties.top.properties.PropertyBuilder
@Generated("mdsal-binding-generator") public class PropertyBuilder extends Object
Class that builds Property 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: 

   
     Property createProperty(int fooXyzzy, int barBaz) {
         return new PropertyBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PropertyBuilder

      public PropertyBuilder()
      Construct an empty builder.

    • PropertyBuilder

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

  • Method Details

    • key

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

    • getConfig

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

    • getName

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

    • getState

      public State getState()
      Return current value associated with the property corresponding to Property.getState().
      Returns:
      current value

    • augmentation

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

    • withKey

      public PropertyBuilder withKey(PropertyKey key)
      Set the key value corresponding to Property.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setConfig

      public PropertyBuilder setConfig(Config value)
      Set the property corresponding to Property.getConfig() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setName

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

    • setState

      public PropertyBuilder setState(State value)
      Set the property corresponding to Property.getState() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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