Package org.opendaylight.yangtools.rfc8819.model.api

Record Class Prefix

java.lang.Object
java.lang.Record
org.opendaylight.yangtools.rfc8819.model.api.Prefix
public record Prefix(@NonNull String value) extends Record
YANG Module Tag Prefixes Registry, as defined in RFC8819.

This registry allocates tag prefixes. All YANG module tags SHOULD begin with one of the prefixes in this registry. Prefix entries in this registry should be short strings consisting of lowercase ASCII alpha-numeric characters and a final ":" character.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull Prefix
    IETF
    ietf: Prefix.
    static final @NonNull Prefix
    USER
    user: Prefix.
    static final @NonNull Prefix
    VENDOR
    vendor: Prefix.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Prefix(@NonNull String value)
    Creates an instance of a Prefix record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    @NonNull Prefix
    intern()
     
    final String
    toString()
    Returns a string representation of this record class.
    @NonNull String
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • IETF

      public static final @NonNull Prefix IETF
      ietf: Prefix. Covers mechanics specified in RFC8819 section 7.1, table 1 
          IETF tags allocated in the IANA "IETF YANG Module Tags" registry.

    • VENDOR

      public static final @NonNull Prefix VENDOR
      vendor: Prefix. Covers mechanics specified in RFC8819 section 7.1, table 1 
           Non-registered tags allocated by the module implementer.

    • USER

      public static final @NonNull Prefix USER
      user: Prefix. Covers mechanics specified in RFC8819 section 7.1, table 1 
           Non-registered tags allocated by and for the user.

  • Constructor Details

    • Prefix

      public Prefix(@NonNull String value)
      Creates an instance of a Prefix record class.
      Parameters:
      value - the value for the value record component

  • Method Details

    • intern

      public @NonNull Prefix intern()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • value

      public @NonNull String value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component