Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance

Class AuthenticationKeyBuilder

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

   
     AuthenticationKey createAuthenticationKey(int fooXyzzy, int barBaz) {
         return new AuthenticationKeyBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • AuthenticationKeyBuilder

      public AuthenticationKeyBuilder()
      Construct an empty builder.

    • AuthenticationKeyBuilder

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

    • AuthenticationKeyBuilder

      public AuthenticationKeyBuilder(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

    • AuthenticationKeyBuilder

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

    • key

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

    • getEid

      public org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid getEid()
      Return current value associated with the property corresponding to EidContainer.getEid().
      Returns:
      current value

    • getEidUri

      public EidUri getEidUri()
      Return current value associated with the property corresponding to AuthenticationKey.getEidUri().
      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

    • augmentation

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

    • setEid

      public AuthenticationKeyBuilder setEid(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid value)
      Set the property corresponding to EidContainer.getEid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setEidUri

      public AuthenticationKeyBuilder setEidUri(EidUri value)
      Set the property corresponding to AuthenticationKey.getEidUri() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMappingAuthkey

      public AuthenticationKeyBuilder 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

    • addAugmentation

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