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

Interface State

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.Augmentable<State>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Component>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, PlatformComponentConfig, PlatformComponentMemoryState, PlatformComponentPowerState, PlatformComponentState, PlatformComponentTempState

@Generated("mdsal-binding-generator")
public interface State
extends org.opendaylight.yangtools.yang.binding.ChildOf<Component>, org.opendaylight.yangtools.yang.binding.Augmentable<State>, PlatformComponentConfig, PlatformComponentState, PlatformComponentTempState, PlatformComponentMemoryState, PlatformComponentPowerState

Operational state data for each component

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

 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;
 }
 

The schema path to identify an instance is openconfig-platformplatform-component-topcomponentscomponentstate

To create instances of this class use StateBuilder.

See Also:

StateBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.PlatformComponentState

PlatformComponentState.Type

Field Summary

Fields

Modifier and Type	Field	Description
static @NonNull org.opendaylight.yangtools.yang.common.QName	QNAME

Method Summary

Modifier and Type	Method	Description
static boolean	bindingEquals(@NonNull State thisObj, Object obj)	Default implementation of Object.equals(Object) contract for this interface.
static int	bindingHashCode(@NonNull State obj)	Default implementation of Object.hashCode() contract for this interface.
static String	bindingToString(@NonNull State obj)	Default implementation of Object.toString() contract for this interface.
String	getParent()	Return parent, or null if it is not present.
default Class<State>	implementedInterface()

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

augmentation, augmentations

Methods inherited from interface org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.PlatformComponentConfig

getName, requireName

Methods inherited from interface org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.PlatformComponentMemoryState

getMemory

Methods inherited from interface org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.PlatformComponentPowerState

getAllocatedPower, getUsedPower, requireAllocatedPower, requireUsedPower

Methods inherited from interface org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.PlatformComponentState

getDescription, getEmpty, getFirmwareVersion, getHardwareVersion, getId, getLocation, getMfgDate, getMfgName, getOperStatus, getPartNo, getRemovable, getSerialNo, getSoftwareVersion, getType, requireDescription, requireEmpty, requireFirmwareVersion, requireHardwareVersion, requireId, requireLocation, requireMfgDate, requireMfgName, requireOperStatus, requireParent, requirePartNo, requireRemovable, requireSerialNo, requireSoftwareVersion, requireType

Methods inherited from interface org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.PlatformComponentTempState

getTemperature

Field Detail

QNAME

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

Method Detail

implementedInterface

default Class<State> implementedInterface()

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

Specified by:

implementedInterface in interface PlatformComponentConfig

Specified by:

implementedInterface in interface PlatformComponentMemoryState

Specified by:

implementedInterface in interface PlatformComponentPowerState

Specified by:

implementedInterface in interface PlatformComponentState

Specified by:

implementedInterface in interface PlatformComponentTempState

bindingHashCode

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

getParent

String getParent()

Return parent, or null if it is not present.

     
         Reference to the name of the parent component. Note that this reference must be
         kept synchronized with the corresponding subcomponent reference from the parent
         component.
     
 

Specified by:

getParent in interface PlatformComponentState

Returns:

String parent, or null if it is not present.