Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.entity.owners.norev.get.entities.output

Class EntitiesBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.entity.owners.norev.get.entities.output.EntitiesBuilder
@Generated("mdsal-binding-generator") public class EntitiesBuilder extends Object
Class that builds Entities 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: 

   
     Entities createEntities(int fooXyzzy, int barBaz) {
         return new EntitiesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • EntitiesBuilder

      public EntitiesBuilder()
      Construct an empty builder.

    • EntitiesBuilder

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

    • EntitiesBuilder

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

    • EntitiesBuilder

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

    • EntitiesBuilder

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

    • EntitiesBuilder

      public EntitiesBuilder(Entities base)
      Construct a builder initialized with state from specified Entities.
      Parameters:
      base - Entities 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

    • key

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

    • getCandidateNodes

      public List<NodeName> getCandidateNodes()
      Return current value associated with the property corresponding to Candidates.getCandidateNodes().
      Returns:
      current value

    • getName

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

    • getOwnerNode

      public NodeName getOwnerNode()
      Return current value associated with the property corresponding to Owner.getOwnerNode().
      Returns:
      current value

    • getType

      public EntityType getType()
      Return current value associated with the property corresponding to EntityId.getType().
      Returns:
      current value

    • augmentation

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

    • setCandidateNodes

      public EntitiesBuilder setCandidateNodes(List<NodeName> values)
      Set the property corresponding to Candidates.getCandidateNodes() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setName

      public EntitiesBuilder setName(EntityName value)
      Set the property corresponding to EntityId.getName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setOwnerNode

      public EntitiesBuilder setOwnerNode(NodeName value)
      Set the property corresponding to Owner.getOwnerNode() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setType

      public EntitiesBuilder setType(EntityType value)
      Set the property corresponding to EntityId.getType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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