Package org.opendaylight.yang.gen.v1.http.netconfcentral.org.ns.toaster.rev091120

Interface Toaster

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Toaster>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<ToasterData>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface Toaster
extends org.opendaylight.yangtools.yang.binding.ChildOf<ToasterData>, org.opendaylight.yangtools.yang.binding.Augmentable<Toaster>
    Top-level container for all toaster database objects.

    This class represents the following YANG schema fragment defined in module toaster 

     container toaster {
   presence "Indicates the toaster service is available";
   leaf toasterManufacturer {
     type DisplayString;
     config false;
   }
   leaf toasterModelNumber {
     type DisplayString;
     config false;
   }
   leaf toasterStatus {
     type enumeration {
       enum up {
         value 1;
       }
       enum down {
         value 2;
       }
     }
     config false;
   }
   leaf darknessFactor {
     type uint32;
     default 1000;
   }
 }
    The schema path to identify an instance is toastertoaster

    To create instances of this class use ToasterBuilder.

    See Also:
    ToasterBuilder

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<Toaster> 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 Toaster 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 Toaster 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 Toaster 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

      • getToasterManufacturer

        DisplayString getToasterManufacturer()
        Return toasterManufacturer, or null if it is not present. 
             
         The name of the toaster's manufacturer. For instance, Microsoft Toaster.
        Returns:
        DisplayString toasterManufacturer, or null if it is not present.

      • requireToasterManufacturer

        default @NonNull DisplayString requireToasterManufacturer()
        Return toasterManufacturer, guaranteed to be non-null. 
             
         The name of the toaster's manufacturer. For instance, Microsoft Toaster.
        Returns:
        DisplayString toasterManufacturer, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if toasterManufacturer is not present

      • getToasterModelNumber

        DisplayString getToasterModelNumber()
        Return toasterModelNumber, or null if it is not present. 
             
         The name of the toaster's model. For instance, Radiant Automatic.
        Returns:
        DisplayString toasterModelNumber, or null if it is not present.

      • requireToasterModelNumber

        default @NonNull DisplayString requireToasterModelNumber()
        Return toasterModelNumber, guaranteed to be non-null. 
             
         The name of the toaster's model. For instance, Radiant Automatic.
        Returns:
        DisplayString toasterModelNumber, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if toasterModelNumber is not present

      • getToasterStatus

        Toaster.ToasterStatus getToasterStatus()
        Return toasterStatus, or null if it is not present. 
             
         This variable indicates the current state of the toaster.
        Returns:
        ToasterStatus toasterStatus, or null if it is not present.

      • requireToasterStatus

        default @NonNull Toaster.ToasterStatus requireToasterStatus()
        Return toasterStatus, guaranteed to be non-null. 
             
         This variable indicates the current state of the toaster.
        Returns:
        ToasterStatus toasterStatus, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if toasterStatus is not present

      • getDarknessFactor

        org.opendaylight.yangtools.yang.common.Uint32 getDarknessFactor()
        Return darknessFactor, or null if it is not present. 
             
         The darkness factor. Basically, the number of ms to multiple the doneness value
         by.
        Returns:
        Uint32 darknessFactor, or null if it is not present.

      • requireDarknessFactor

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireDarknessFactor()
        Return darknessFactor, guaranteed to be non-null. 
             
         The darkness factor. Basically, the number of ms to multiple the doneness value
         by.
        Returns:
        Uint32 darknessFactor, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if darknessFactor is not present