All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
Details, Entities, GetEntityOutput

@Generated("mdsal-binding-generator") public interface Candidates extends org.opendaylight.yangtools.yang.binding.DataObject

This class represents the following YANG schema fragment defined in module odl-entity-owners

 grouping candidates {
   leaf-list candidate-nodes {
     type node-name;
     ordered-by user;
     min-elements 1;
   }
 }
 
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    YANG identifier of the statement represented by this class.
  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable List<NodeName>
    Return candidateNodes, or null if it is not present.
    Class<? extends Candidates>
     
    default @NonNull List<NodeName>
    Return candidateNodes, guaranteed to be non-null.
  • 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

      Class<? extends Candidates> 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
    • getCandidateNodes

      @Nullable List<NodeName> getCandidateNodes()
      Return candidateNodes, or null if it is not present.
      Returns:
      List<NodeName> candidateNodes, or null if it is not present.
    • requireCandidateNodes

      default @NonNull List<NodeName> requireCandidateNodes()
      Return candidateNodes, guaranteed to be non-null.
      Returns:
      List<NodeName> candidateNodes, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if candidateNodes is not present