Interface Endpoints

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Endpoints>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<ConnectionPoint>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

    @Generated("mdsal-binding-generator")
    public interface Endpoints
    extends org.opendaylight.yangtools.yang.binding.ChildOf<ConnectionPoint>, org.opendaylight.yangtools.yang.binding.Augmentable<Endpoints>
    The set of endpoints which are grouped within the connection point

    This class represents the following YANG schema fragment defined in module openconfig-network-instance

     container endpoints {
       when "../config/type = 'L2P2P' or ../config/type = 'L2VSI'" {
       }
       list endpoint {
         key endpoint-id;
         leaf endpoint-id {
           type leafref {
             path ../config/endpoint-id;
           }
         }
         container config {
           uses instance-endpoint-config;
         }
         container state {
           config false;
           uses instance-endpoint-config;
           uses instance-endpoint-state;
         }
       }
     }
     

    To create instances of this class use EndpointsBuilder.

    See Also:
    EndpointsBuilder
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.
    • Method Detail

      • implementedInterface

        default Class<Endpoints> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • bindingHashCode

        static int bindingHashCode​(@NonNull Endpoints obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null
      • bindingEquals

        static boolean bindingEquals​(@NonNull Endpoints thisObj,
                                     Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        NullPointerException - if thisObj is null
      • bindingToString

        static String bindingToString​(@NonNull Endpoints obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null
      • getEndpoint

        @Nullable Map<EndpointKey,​Endpoint> getEndpoint()
        Return endpoint, or null if it is not present.
             
                 A list of the endpoints (interfaces or remote connection points that can be used
                 for this connection point). The active endpoint is selected based on the
                 precedence that it is configured with
             
         
        Returns:
        Map<EndpointKey, Endpoint> endpoint, or null if it is not present.
      • nonnullEndpoint

        default @NonNull Map<EndpointKey,​Endpoint> nonnullEndpoint()
        Return endpoint, or an empty list if it is not present.
        Returns:
        Map<EndpointKey, Endpoint> endpoint, or an empty list if it is not present.