Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.authkey.list

Class MappingAuthkeyItemBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.authkey.list.MappingAuthkeyItemBuilder
@Generated("mdsal-binding-generator") public class MappingAuthkeyItemBuilder extends Object
Class that builds MappingAuthkeyItem 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: 

   
     MappingAuthkeyItem createMappingAuthkeyItem(int fooXyzzy, int barBaz) {
         return new MappingAuthkeyItemBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MappingAuthkeyItemBuilder

      public MappingAuthkeyItemBuilder()
      Construct an empty builder.

    • MappingAuthkeyItemBuilder

      public MappingAuthkeyItemBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingAuthkeyContainer arg)
      Construct a new builder initialized from specified MappingAuthkeyContainer.
      Parameters:
      arg - MappingAuthkeyContainer from which the builder should be initialized

    • MappingAuthkeyItemBuilder

      public MappingAuthkeyItemBuilder(MappingAuthkeyItem base)
      Construct a builder initialized with state from specified MappingAuthkeyItem.
      Parameters:
      base - MappingAuthkeyItem 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:
      • MappingAuthkeyContainer
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • key

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

    • getMappingAuthkey

      public org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.authkey.container.MappingAuthkey getMappingAuthkey()
      Return current value associated with the property corresponding to MappingAuthkeyContainer.getMappingAuthkey().
      Returns:
      current value

    • getMappingAuthkeyItemId

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

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingAuthkeyItem>> 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 MappingAuthkeyItemBuilder withKey(MappingAuthkeyItemKey key)
      Set the key value corresponding to MappingAuthkeyItem.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setMappingAuthkey

      public MappingAuthkeyItemBuilder setMappingAuthkey(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.authkey.container.MappingAuthkey value)
      Set the property corresponding to MappingAuthkeyContainer.getMappingAuthkey() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMappingAuthkeyItemId

      public MappingAuthkeyItemBuilder setMappingAuthkeyItemId(String value)
      Set the property corresponding to MappingAuthkeyItem.getMappingAuthkeyItemId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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