Package com.unboundid.ldap.sdk

Class RDNNameValuePair

java.lang.Object
com.unboundid.ldap.sdk.RDNNameValuePair
All Implemented Interfaces:
Serializable, Comparable<RDNNameValuePair>, Comparator<RDNNameValuePair>
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class RDNNameValuePair extends Object implements Comparable<RDNNameValuePair>, Comparator<RDNNameValuePair>, Serializable
This class provides a data structure that represents a single name-value pair that may appear in a relative distinguished name.
See Also:

  • Method Details

    • getAttributeName

      @NotNull public String getAttributeName()
      Retrieves the attribute name for this name-value pair.
      Returns:
      The attribute name for this name-value pair.

    • getNormalizedAttributeName

      @NotNull public String getNormalizedAttributeName()
      Retrieves a normalized representation of the attribute name.
      Returns:
      A normalized representation of the attribute name.

    • hasAttributeName

      public boolean hasAttributeName(@NotNull String name)
      Indicates whether this RDN name-value pair has the provided attribute name (or a name that is logically equivalent to it).
      Parameters:
      name - The name for which to make the determination.
      Returns:
      true if this name-value pair has the provided attribute name (or a name that is logically equivalent to it), or false if not.

    • getAttributeValue

      @NotNull public String getAttributeValue()
      Retrieves the string representation of the attribute value for this name-value pair.
      Returns:
      The string representation of the attribute value for this name-value pair.

    • getAttributeValueBytes

      @NotNull public byte[] getAttributeValueBytes()
      Retrieves the bytes that comprise the attribute value for this name-value pair.
      Returns:
      The bytes that comprise the attribute value for this name-value pair.

    • getRawAttributeValue

      @NotNull public ASN1OctetString getRawAttributeValue()
      Retrieves the raw attribute value for this name-value pair.
      Returns:
      The raw attribute value for this name-value pair.

    • hasAttributeValue

      public boolean hasAttributeValue(@NotNull String value)
      Indicates whether this RDN name-value pair has the provided attribute value (or a value that is logically equivalent to it).
      Parameters:
      value - The value for which to make the determination.
      Returns:
      true if this RDN name-value pair has the provided attribute value (or a value that is logically equivalent to it), or false if not.

    • hasAttributeValue

      public boolean hasAttributeValue(@NotNull byte[] value)
      Indicates whether this RDN name-value pair has the provided attribute value (or a value that is logically equivalent to it).
      Parameters:
      value - The value for which to make the determination.
      Returns:
      true if this RDN name-value pair has the provided attribute value (or a value that is logically equivalent to it), or false if not.

    • compareTo

      public int compareTo(@NotNull RDNNameValuePair p)
      Retrieves an integer value that represents the order in which this RDN name-value pair should be placed in relation to the provided RDN name-value pair in a sorted list.
      Specified by:
      compareTo in interface Comparable<RDNNameValuePair>
      Parameters:
      p - The RDN name-value pair to be ordered relative to this RDN name-value pair. It must not be null.
      Returns:
      A negative integer if this RDN name-value pair should be ordered before the provided RDN name-value pair, a positive integer if this RDN name-value pair should be ordered after the provided RDN name-value pair, or zero if this RDN name-value pair is logically equivalent to the provided RDN name-value pair.

    • compare

      public int compare(@NotNull RDNNameValuePair p1, @NotNull RDNNameValuePair p2)
      Retrieves an integer value that represents the order in which the provided RDN name-value pairs should be placed in a sorted list.
      Specified by:
      compare in interface Comparator<RDNNameValuePair>
      Parameters:
      p1 - The first RDN name-value pair to compare. It must not be null.
      p2 - The second RDN name-value pair to compare. It must not be null.
      Returns:
      A negative integer if the first RDN name-value pair should be ordered before the second RDN name-value pair, a positive integer if the first RDN name-value pair should be ordered after the second RDN name-value pair, or zero if the provided RDN name-value pairs are logically equivalent.

    • hashCode

      public int hashCode()
      Retrieves a hash code for this RDN name-value pair.
      Overrides:
      hashCode in class Object
      Returns:
      A hash code for this RDN name-value pair.

    • equals

      public boolean equals(@Nullable Object o)
      Indicates whether the provided object is considered logically equivalent to this RDN name-value pair.
      Specified by:
      equals in interface Comparator<RDNNameValuePair>
      Overrides:
      equals in class Object
      Parameters:
      o - The object for which to make the determination.
      Returns:
      true if the provided object is an RDN name-value pair that is logically equivalent to this RDN name-value pair, or false if not.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this RDN name-value pair.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this RDN name-value pair.

    • toMinimallyEncodedString

      @NotNull public String toMinimallyEncodedString()
      Retrieves a string representation of this RDN name-value pair with minimal encoding for special characters. Only those characters specified in RFC 4514 section 2.4 will be escaped. No escaping will be used for non-ASCII characters or non-printable ASCII characters.
      Returns:
      A string representation of this RDN name-value pair with minimal encoding for special characters.

    • toString

      public void toString(@NotNull StringBuilder buffer, boolean minimizeEncoding)
      Appends a string representation of this RDN name-value pair to the provided buffer.
      Parameters:
      buffer - The buffer to which the string representation is to be appended.
      minimizeEncoding - Indicates whether to restrict the encoding of special characters to the bare minimum required by LDAP (as per RFC 4514 section 2.4). If this is true, then only leading and trailing spaces, double quotes, plus signs, commas, semicolons, greater-than, less-than, and backslash characters will be encoded.

    • toString

      public void toString(@NotNull ByteStringBuffer buffer, @NotNull DNEscapingStrategy escapingStrategy)
      Appends a string representation of this RDN name-value pair to the provided buffer.
      Parameters:
      buffer - The buffer to which the string representation is to be appended. It must not be null.
      escapingStrategy - The strategy to use to determine which types of optional escaping should be used for values. It must not be null.

    • toNormalizedString

      @NotNull public String toNormalizedString()
      Retrieves a normalized string representation of this RDN name-value pair.
      Returns:
      A normalized string representation of this RDN name-value pair.

    • toNormalizedString

      public void toNormalizedString(@NotNull StringBuilder buffer)
      Appends a normalized string representation of this RDN name-value pair to the provided buffer.
      Parameters:
      buffer - The buffer to which the normalized string representation should be appended. It must not be null.