DnsLabel (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

java.lang.Object
- org.minidns.util.SafeCharSequence
- - org.minidns.dnslabel.DnsLabel

All Implemented Interfaces:
CharSequence, Comparable<DnsLabel>
Direct Known Subclasses:
LdhLabel, NonLdhLabel
```
public abstract class DnsLabel
extends SafeCharSequence
implements Comparable<DnsLabel>
```
A DNS label is an individual component of a DNS name. Labels are usually shown separated by dots.
This class implements Comparable which compares DNS labels according to the Canonical DNS Name Order as specified in RFC 4034 § 6.1.
Note that as per RFC 2181 § 11 DNS labels may contain any byte.
See Also:
RFC 5890 § 2.2. DNS-Related Terminology

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
static class DnsLabel.LabelToLongException
Thrown when a DNS label exceeds the maximum length.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DnsLabel.LabelToLongException` Thrown when a DNS label exceeds the maximum length.

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`label` The label string.
`static int`	`MAX_LABEL_LENGTH_IN_OCTETS` The maximum length of a DNS label in octets.
`static DnsLabel`	`WILDCARD_LABEL` The wildcard label.

Constructor Summary
Constructors
Modifier Constructor and Description
protected DnsLabel(String label)
DnsLabel.

Constructors
Modifier	Constructor and Description
`protected`	`DnsLabel(String label)` DnsLabel.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DnsLabel`	`asLowercaseVariant()` Get the lowercase variant of this label.
`int`	`compareTo(DnsLabel other)` compareTo.
`static boolean`	`consistsOnlyOfLettersDigitsAndHypen(String string)` Check if a string consists of only letters, digits, and hyphens.
`static boolean`	`consistsOnlyOfLettersDigitsHypenAndUnderscore(String string)` Check if a string consists of only letters, digits, hyphens, and underscores.
`boolean`	`equals(Object other)` equals.
`static DnsLabel`	`from(String label)` Create a DnsLabel from a string.
`static DnsLabel[]`	`from(String[] labels)` Create DnsLabel array from string array.
`String`	`getInternationalizedRepresentation()` Get the internationalized representation of this label.
`protected String`	`getInternationalizedRepresentationInternal()` Gets the internal internationalized representation.
`String`	`getLabelType()` Get the type of this label.
`String`	`getRawLabel()` Get the raw label.
`int`	`hashCode()` hashCode.
`static boolean`	`isIdnAcePrefixed(String string)` Check if a string has the IDN ACE prefix.
`static String`	`toSafeRepesentation(String dnsLabel)` Convert a DNS label string to a safe representation.
`String`	`toString()` toString.
`void`	`writeToBoas(ByteArrayOutputStream byteArrayOutputStream)` Write this label to a ByteArrayOutputStream prefixed by its length.

Methods inherited from class org.minidns.util.SafeCharSequence
charAt, length, subSequence, toSafeString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence
chars, codePoints

- Field Detail
  - label
```
public final String label
```
    The label string.
  - MAX_LABEL_LENGTH_IN_OCTETS
```
public static final int MAX_LABEL_LENGTH_IN_OCTETS
```
    The maximum length of a DNS label in octets.
    See Also:
    RFC 1035 § 2.3.4., Constant Field Values
  - WILDCARD_LABEL
```
public static final DnsLabel WILDCARD_LABEL
```
    The wildcard label.
- Constructor Detail
  - DnsLabel
```
protected DnsLabel(String label)
```
    DnsLabel.
- Method Detail
  - asLowercaseVariant
```
public final DnsLabel asLowercaseVariant()
```
    Get the lowercase variant of this label.
    Returns:
    the lowercase label
  - compareTo
```
public final int compareTo(DnsLabel other)
```
    compareTo.
    Specified by:
    compareTo in interface Comparable<DnsLabel>
  - consistsOnlyOfLettersDigitsAndHypen
```
public static boolean consistsOnlyOfLettersDigitsAndHypen(String string)
```
    Check if a string consists of only letters, digits, and hyphens.
    Parameters:
    string - the string to check
    Returns:
    true if it matches LDH rules
  - consistsOnlyOfLettersDigitsHypenAndUnderscore
```
public static boolean consistsOnlyOfLettersDigitsHypenAndUnderscore(String string)
```
    Check if a string consists of only letters, digits, hyphens, and underscores.
    Parameters:
    string - the string to check
    Returns:
    true if it matches LDH or underscore rules
  - equals
```
public final boolean equals(Object other)
```
    equals.
    Overrides:
    equals in class Object
  - from
```
public static DnsLabel from(String label)
```
    Create a DnsLabel from a string.
    Parameters:
    label - the label string
    Returns:
    the DnsLabel
  - from
```
public static DnsLabel[] from(String[] labels)
```
    Create DnsLabel array from string array.
    Parameters:
    labels - the label strings
    Returns:
    the DnsLabel array
  - getInternationalizedRepresentation
```
public final String getInternationalizedRepresentation()
```
    Get the internationalized representation of this label.
    Returns:
    the internationalized label
  - getInternationalizedRepresentationInternal
```
protected String getInternationalizedRepresentationInternal()
```
    Gets the internal internationalized representation.
    Returns:
    label string
  - getLabelType
```
public final String getLabelType()
```
    Get the type of this label.
    Returns:
    the simple class name
  - getRawLabel
```
public final String getRawLabel()
```
    Get the raw label. Note that this may return a String containing null bytes. Those Strings are notoriously difficult to handle from a security perspective. Therefore it is recommended to use toString() instead, which will return a sanitized String.
    Returns:
    the raw label.
  - hashCode
```
public final int hashCode()
```
    hashCode.
    Overrides:
    hashCode in class Object
  - isIdnAcePrefixed
```
public static boolean isIdnAcePrefixed(String string)
```
    Check if a string has the IDN ACE prefix.
    Parameters:
    string - the string to check
    Returns:
    true if the string starts with "xn--"
  - toSafeRepesentation
```
public static String toSafeRepesentation(String dnsLabel)
```
    Convert a DNS label string to a safe representation.
    Parameters:
    dnsLabel - the label to convert
    Returns:
    safe string representation
  - toString
```
public final String toString()
```
    toString.
    Specified by:
    toString in interface CharSequence
    Overrides:
    toString in class Object
  - writeToBoas
```
public final void writeToBoas(ByteArrayOutputStream byteArrayOutputStream)
```
    Write this label to a ByteArrayOutputStream prefixed by its length.
    Parameters:
    byteArrayOutputStream - the output stream to write to

Class DnsLabel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.minidns.util.SafeCharSequence

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.CharSequence

Field Detail

label

MAX_LABEL_LENGTH_IN_OCTETS

WILDCARD_LABEL

Constructor Detail

DnsLabel

Method Detail

asLowercaseVariant

compareTo

consistsOnlyOfLettersDigitsAndHypen

consistsOnlyOfLettersDigitsHypenAndUnderscore

equals

from

from

getInternationalizedRepresentation

getInternationalizedRepresentationInternal

getLabelType

getRawLabel

hashCode

isIdnAcePrefixed

toSafeRepesentation

toString

writeToBoas