Interface Aggregate

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Aggregate>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<LocalAggregates>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<AggregateKey>

    @Generated("mdsal-binding-generator")
    public interface Aggregate
    extends org.opendaylight.yangtools.yang.binding.ChildOf<LocalAggregates>, org.opendaylight.yangtools.yang.binding.Augmentable<Aggregate>, org.opendaylight.yangtools.yang.binding.Identifiable<AggregateKey>
    List of aggregates

    This class represents the following YANG schema fragment defined in module openconfig-local-routing

     list aggregate {
       key prefix;
       leaf prefix {
         type leafref {
           path ../config/prefix;
         }
       }
       container config {
         uses local-aggregate-config;
       }
       container state {
         config false;
         uses local-aggregate-config;
         uses local-aggregate-state;
       }
     }
     

    To create instances of this class use AggregateBuilder.

    See Also:
    AggregateBuilder, AggregateKey
    • 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<Aggregate> 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 Aggregate 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 Aggregate 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 Aggregate 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
      • key

        AggregateKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<AggregateKey>
      • getPrefix

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
        Return prefix, or null if it is not present.
             
                 Reference to the configured prefix for this aggregate
             
         
        Returns:
        IpPrefix prefix, or null if it is not present.
      • requirePrefix

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix requirePrefix()
        Return prefix, guaranteed to be non-null.
             
                 Reference to the configured prefix for this aggregate
             
         
        Returns:
        IpPrefix prefix, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if prefix is not present
      • getConfig

        Config getConfig()
        Return config, or null if it is not present.
             
                 Configuration data for aggregate advertisements
             
         
        Returns:
        Config config, or null if it is not present.
      • getState

        State getState()
        Return state, or null if it is not present.
             
                 Operational state data for aggregate advertisements
             
         
        Returns:
        State state, or null if it is not present.