Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.igp.node.attributes

Class PrefixBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.igp.node.attributes.PrefixBuilder
@Generated("mdsal-binding-generator") public class PrefixBuilder extends Object
Class that builds Prefix 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: 

   
     Prefix createPrefix(int fooXyzzy, int barBaz) {
         return new PrefixBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PrefixBuilder

      public PrefixBuilder()
      Construct an empty builder.

    • PrefixBuilder

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

    • PrefixBuilder

      public PrefixBuilder(Prefix base)
      Construct a builder initialized with state from specified Prefix.
      Parameters:
      base - Prefix 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 PrefixKey key()
      Return current value associated with the property corresponding to Prefix.key().
      Returns:
      current value

    • getFlag

      public Set<FlagIdentity> getFlag()
      Return current value associated with the property corresponding to IgpPrefixAttributes.getFlag().
      Returns:
      current value

    • getMetric

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

    • getPrefix

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
      Return current value associated with the property corresponding to IgpPrefixAttributes.getPrefix().
      Returns:
      current value

    • augmentation

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

    • setFlag

      public PrefixBuilder setFlag(Set<FlagIdentity> values)
      Set the property corresponding to IgpPrefixAttributes.getFlag() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setMetric

      public PrefixBuilder setMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to IgpPrefixAttributes.getMetric() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPrefix

      public PrefixBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
      Set the property corresponding to IgpPrefixAttributes.getPrefix() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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