Package org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.geo.coordinates

Class GeoCoordinatesBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<GeoCoordinates>, org.opendaylight.yangtools.concepts.CheckedBuilder<GeoCoordinates,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class GeoCoordinatesBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<GeoCoordinates>
    Class that builds GeoCoordinatesBuilder 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: 

       
     GeoCoordinatesBuilder createTarget(int fooXyzzy, int barBaz) {
         return new GeoCoordinatesBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

    This pattern is supported by the immutable nature of GeoCoordinatesBuilder, 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 oportunities, 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:
    GeoCoordinatesBuilder, Builder

    • Constructor Detail

      • GeoCoordinatesBuilder

        public GeoCoordinatesBuilder()

      • GeoCoordinatesBuilder

        public GeoCoordinatesBuilder​(GeoCoordinates base)

    • Method Detail

      • getAltitude

        public java.lang.Integer getAltitude()

      • getLatitudeDegrees

        public org.opendaylight.yangtools.yang.common.Uint8 getLatitudeDegrees()

      • getLatitudeMinutes

        public org.opendaylight.yangtools.yang.common.Uint8 getLatitudeMinutes()

      • getLatitudeSeconds

        public org.opendaylight.yangtools.yang.common.Uint8 getLatitudeSeconds()

      • getLongitudeDegrees

        public org.opendaylight.yangtools.yang.common.Uint16 getLongitudeDegrees()

      • getLongitudeMinutes

        public org.opendaylight.yangtools.yang.common.Uint8 getLongitudeMinutes()

      • getLongitudeSeconds

        public org.opendaylight.yangtools.yang.common.Uint8 getLongitudeSeconds()

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GeoCoordinates>> E$$ augmentation​(java.lang.Class<E$$> augmentationType)

      • setLatitudeDegrees

        public GeoCoordinatesBuilder setLatitudeDegrees​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setLatitudeDegrees

        @Deprecated(forRemoval=true)
public GeoCoordinatesBuilder setLatitudeDegrees​(java.lang.Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setLatitudeDegrees(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setLatitudeMinutes

        public GeoCoordinatesBuilder setLatitudeMinutes​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setLatitudeMinutes

        @Deprecated(forRemoval=true)
public GeoCoordinatesBuilder setLatitudeMinutes​(java.lang.Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setLatitudeMinutes(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setLatitudeSeconds

        public GeoCoordinatesBuilder setLatitudeSeconds​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setLatitudeSeconds

        @Deprecated(forRemoval=true)
public GeoCoordinatesBuilder setLatitudeSeconds​(java.lang.Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setLatitudeSeconds(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setLongitudeDegrees

        public GeoCoordinatesBuilder setLongitudeDegrees​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setLongitudeDegrees

        @Deprecated(forRemoval=true)
public GeoCoordinatesBuilder setLongitudeDegrees​(java.lang.Integer value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setLongitudeDegrees(Uint16) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setLongitudeMinutes

        public GeoCoordinatesBuilder setLongitudeMinutes​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setLongitudeMinutes

        @Deprecated(forRemoval=true)
public GeoCoordinatesBuilder setLongitudeMinutes​(java.lang.Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setLongitudeMinutes(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setLongitudeSeconds

        public GeoCoordinatesBuilder setLongitudeSeconds​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setLongitudeSeconds

        @Deprecated(forRemoval=true)
public GeoCoordinatesBuilder setLongitudeSeconds​(java.lang.Short value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setLongitudeSeconds(Uint8) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • addAugmentation

        public GeoCoordinatesBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<GeoCoordinates> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        java.lang.NullPointerException - if augmentation is null

      • removeAugmentation

        public GeoCoordinatesBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GeoCoordinates>> 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 GeoCoordinates build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<GeoCoordinates>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<GeoCoordinates,​java.lang.IllegalArgumentException>