Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.platform.component.top.components

Interface Component

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Component>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Components>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.KeyAware<ComponentKey>, PlatformAnchorsTop, PlatformComponentPropertiesTop, PlatformSubcomponentRefTop
@Generated("mdsal-binding-generator") public interface Component extends org.opendaylight.yangtools.yang.binding.ChildOf<Components>, org.opendaylight.yangtools.yang.binding.Augmentable<Component>, PlatformComponentPropertiesTop, PlatformSubcomponentRefTop, PlatformAnchorsTop, org.opendaylight.yangtools.yang.binding.KeyAware<ComponentKey>
List of components, keyed by component name.

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

 list component {
   key name;
   leaf name {
     type leafref {
       path ../config/name;
     }
   }
   container config {
     uses platform-component-config;
   }
   container state {
     config false;
     uses platform-component-config;
     uses platform-component-state;
     uses platform-component-temp-state;
     uses platform-component-memory-state;
     uses platform-component-power-state;
   }
   uses platform-component-properties-top;
   uses platform-subcomponent-ref-top;
   uses platform-anchors-top;
 }

To create instances of this class use ComponentBuilder.

See Also:

  • Field Details

    • QNAME

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

  • Method Details

    • implementedInterface

      default Class<Component> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      Specified by:
      implementedInterface in interface PlatformAnchorsTop
      Specified by:
      implementedInterface in interface PlatformComponentPropertiesTop
      Specified by:
      implementedInterface in interface PlatformSubcomponentRefTop

    • bindingHashCode

      static int bindingHashCode(@NonNull Component 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 Component 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 Component 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

      ComponentKey key()
      Specified by:
      key in interface org.opendaylight.yangtools.yang.binding.KeyAware<ComponentKey>

    • getName

      String getName()
      Return name, or null if it is not present. 
           
         References the component name
      Returns:
      String name, or null if it is not present.

    • requireName

      default @NonNull String requireName()
      Return name, guaranteed to be non-null. 
           
         References the component name
      Returns:
      String 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 each component
      Returns:
      Config config, or null if it is not present.

    • nonnullConfig

      @NonNull Config nonnullConfig()
      Return config, or an empty instance if it is not present.
      Returns:
      Config config, or an empty instance if it is not present.

    • getState

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

    • nonnullState

      @NonNull State nonnullState()
      Return state, or an empty instance if it is not present.
      Returns:
      State state, or an empty instance if it is not present.