Interface Options

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Options>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<OvsdbPortInterfaceAttributes>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<OptionsKey>

    @Generated("mdsal-binding-generator")
    public interface Options
    extends org.opendaylight.yangtools.yang.binding.ChildOf<OvsdbPortInterfaceAttributes>, org.opendaylight.yangtools.yang.binding.Augmentable<Options>, org.opendaylight.yangtools.yang.binding.Identifiable<OptionsKey>
    Port/Interface related optional input values

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

     list options {
       key option;
       leaf option {
         type string;
       }
       leaf value {
         type string;
       }
     }
     

    To create instances of this class use OptionsBuilder.

    See Also:
    OptionsBuilder, OptionsKey
    • 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<Options> 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 Options 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 Options 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 Options 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

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

        String getOption()
        Return option, or null if it is not present.
             
                 Option name
             
         
        Returns:
        String option, or null if it is not present.
      • requireOption

        default @NonNull String requireOption()
        Return option, guaranteed to be non-null.
             
                 Option name
             
         
        Returns:
        String option, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if option is not present
      • getValue

        String getValue()
        Return value, or null if it is not present.
             
                 Option value
             
         
        Returns:
        String value, or null if it is not present.
      • requireValue

        default @NonNull String requireValue()
        Return value, guaranteed to be non-null.
             
                 Option value
             
         
        Returns:
        String value, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if value is not present