Interface Subcomponent

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Subcomponent>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Subcomponents>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<SubcomponentKey>

    @Generated("mdsal-binding-generator")
    public interface Subcomponent
    extends org.opendaylight.yangtools.yang.binding.ChildOf<Subcomponents>, org.opendaylight.yangtools.yang.binding.Augmentable<Subcomponent>, org.opendaylight.yangtools.yang.binding.Identifiable<SubcomponentKey>
    List of subcomponent references

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

     list subcomponent {
       key name;
       leaf name {
         type leafref {
           path ../config/name;
         }
       }
       container config {
         uses platform-subcomponent-ref-config;
       }
       container state {
         config false;
         uses platform-subcomponent-ref-config;
         uses platform-subcomponent-ref-state;
       }
     }
     
    The schema path to identify an instance is openconfig-platformplatform-subcomponent-ref-topsubcomponentssubcomponent

    To create instances of this class use SubcomponentBuilder.

    See Also:
    SubcomponentBuilder, SubcomponentKey
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • Method Detail

      • implementedInterface

        default Class<Subcomponent> 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 Subcomponent 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 Subcomponent 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 Subcomponent 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
      • getName

        Object getName()
        Return name, or null if it is not present.
             
                 Reference to the name list key
             
         
        Returns:
        Object name, or null if it is not present.
      • requireName

        default @NonNull Object requireName()
        Return name, guaranteed to be non-null.
             
                 Reference to the name list key
             
         
        Returns:
        Object name, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if name is not present
      • getConfig

        Config getConfig()
        Return config, or null if it is not present.
             
                 Configuration data for the subcomponent
             
         
        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 the subcomponent
             
         
        Returns:
        State state, or null if it is not present.