java.lang.Object
- org.minidns.util.SafeCharSequence
- - org.minidns.dnsname.DnsName

All Implemented Interfaces:

java.io.Serializable, java.lang.CharSequence, java.lang.Comparable<DnsName>
```
public final class DnsName
extends SafeCharSequence
implements java.io.Serializable, java.lang.Comparable<DnsName>
```
A DNS name, also called "domain name". A DNS name consists of multiple 'labels' (see DnsLabel) and is subject to certain restrictions (see for example RFC 3696 § 2.).
Instances of this class can be created by using from(String).

This class holds three representations of a DNS name: ACE, raw ACE and IDN. ACE (ASCII Compatible Encoding), which can be accessed via ace, represents mostly the data that got send over the wire. But since DNS names are case insensitive, the ACE value is normalized to lower case. You can use getRawAce() to get the raw ACE data that was received, which possibly includes upper case characters. The IDN (Internationalized Domain Name), that is the DNS name as it should be shown to the user, can be retrieved using asIdn().
More information about Internationalized Domain Names can be found at:
- UTS #46 - Unicode IDNA Compatibility Processing
- RFC 8753 - Internationalized Domain Names for Applications (IDNA) Review for New Unicode Versions
See Also:

RFC 3696, DnsLabel, Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`java.lang.String`	`ace`	The DNS name in ASCII Compatible Encoding (ACE).
`static DnsName`	`IN_ADDR_ARPA`
`static DnsName`	`IP6_ARPA`
`static int`	`MAX_LABELS`
`static DnsName`	`ROOT`
`static boolean`	`VALIDATE`	Whether or not the DNS name is validated on construction.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`asIdn()`
`int`	`compareTo(DnsName other)`
`boolean`	`equals(java.lang.Object other)`
`static DnsName`	`from(java.lang.CharSequence name)`
`static DnsName`	`from(java.lang.CharSequence child, DnsName parent)`
`static DnsName`	`from(java.lang.String name)`
`static DnsName`	`from(java.lang.String[] parts)`
`static DnsName`	`from(DnsLabel grandchild, DnsLabel child, DnsName parent)`
`static DnsName`	`from(DnsLabel child, DnsName parent)`
`static DnsName`	`from(DnsName... nameComponents)`
`static DnsName`	`from(DnsName child, DnsName parent)`	Create a DNS name by "concatenating" the child under the parent name.
`java.lang.String`	`getAce()`	Return the ACE (ASCII Compatible Encoding) version of this DNS name.
`byte[]`	`getBytes()`	Serialize a domain name under IDN rules.
`java.lang.String`	`getDomainpart()`	Domainpart in ACE representation.
`java.lang.String`	`getHostpart()`	Hostpart in ACE representation.
`DnsLabel`	`getHostpartLabel()`
`DnsLabel`	`getLabel(int labelNum)`
`int`	`getLabelCount()`
`DnsLabel[]`	`getLabels()`	Get a copy of the labels of this DNS name.
`DnsName`	`getParent()`	Return the parent of this DNS label.
`java.lang.String`	`getRawAce()`	Returns the raw ACE version of this DNS name.
`byte[]`	`getRawBytes()`
`DnsLabel[]`	`getRawLabels()`	Get a copy of the raw labels of this DNS name.
`int`	`hashCode()`
`boolean`	`isChildOf(DnsName parent)`
`boolean`	`isDirectChildOf(DnsName parent)`
`boolean`	`isRootLabel()`
`static DnsName`	`parse(java.io.DataInputStream dis, byte[] data)`	Parse a domain name starting at the current offset and moving the input stream pointer past this domain name (even if cross references occure).
`int`	`size()`
`DnsName`	`stripToLabels(int labelCount)`
`java.lang.String`	`toString()`
`void`	`writeToStream(java.io.OutputStream os)`

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
  - MAX_LABELS
```
public static final int MAX_LABELS
```
    See Also:
    
    Constant Field Values
  - ROOT
```
public static final DnsName ROOT
```
  - IN_ADDR_ARPA
```
public static final DnsName IN_ADDR_ARPA
```
  - IP6_ARPA
```
public static final DnsName IP6_ARPA
```
  - VALIDATE
```
public static boolean VALIDATE
```
    Whether or not the DNS name is validated on construction.
  - ace
```
public final java.lang.String ace
```
    The DNS name in ASCII Compatible Encoding (ACE).
- Method Detail
  - writeToStream
```
public void writeToStream(java.io.OutputStream os)
                   throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getBytes
```
public byte[] getBytes()
```
    Serialize a domain name under IDN rules.
    
    Returns:
    
    The binary domain name representation.
  - getRawBytes
```
public byte[] getRawBytes()
```
  - getAce
```
public java.lang.String getAce()
```
    Return the ACE (ASCII Compatible Encoding) version of this DNS name. Note that this method 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 ACE version of this DNS name.
    
    Since:
    
    1.1.0
  - getRawAce
```
public java.lang.String getRawAce()
```
    Returns the raw ACE version of this DNS name. That is, the version as it was received over the wire. Most notably, this version may include uppercase letters. Please refer to getAce() for a discussion of the security implications when working with the ACE representation of a DNS name.
    
    Returns:
    
    the raw ACE version of this DNS name.
    
    See Also:
    
    getAce()
  - asIdn
```
public java.lang.String asIdn()
```
  - getDomainpart
```
public java.lang.String getDomainpart()
```
    Domainpart in ACE representation.
    
    Returns:
    
    the domainpart in ACE representation.
  - getHostpart
```
public java.lang.String getHostpart()
```
    Hostpart in ACE representation.
    
    Returns:
    
    the hostpart in ACE representation.
  - getHostpartLabel
```
public DnsLabel getHostpartLabel()
```
  - size
```
public int size()
```
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface java.lang.CharSequence
    
    Overrides:
    
    toString in class java.lang.Object
  - from
```
public static DnsName from(java.lang.CharSequence name)
```
  - from
```
public static DnsName from(java.lang.String name)
```
  - from
```
public static DnsName from(DnsName child,
                           DnsName parent)
```
    Create a DNS name by "concatenating" the child under the parent name. The child can also be seen as the "left" part of the resulting DNS name and the parent is the "right" part.
    For example using "i.am.the.child" as child and "of.this.parent.example" as parent, will result in a DNS name: "i.am.the.child.of.this.parent.example".
    
    Parameters:
    
    child - the child DNS name.
    
    parent - the parent DNS name.
    
    Returns:
    
    the resulting of DNS name.
  - from
```
public static DnsName from(java.lang.CharSequence child,
                           DnsName parent)
```
  - from
```
public static DnsName from(DnsLabel child,
                           DnsName parent)
```
  - from
```
public static DnsName from(DnsLabel grandchild,
                           DnsLabel child,
                           DnsName parent)
```
  - from
```
public static DnsName from(DnsName... nameComponents)
```
  - from
```
public static DnsName from(java.lang.String[] parts)
```
  - parse
```
public static DnsName parse(java.io.DataInputStream dis,
                            byte[] data)
                     throws java.io.IOException
```
    Parse a domain name starting at the current offset and moving the input stream pointer past this domain name (even if cross references occure).
    
    Parameters:
    
    dis - The input stream.
    
    data - The raw data (for cross references).
    
    Returns:
    
    The domain name string.
    
    Throws:
    
    java.io.IOException - Should never happen.
  - compareTo
```
public int compareTo(DnsName other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<DnsName>
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - isDirectChildOf
```
public boolean isDirectChildOf(DnsName parent)
```
  - isChildOf
```
public boolean isChildOf(DnsName parent)
```
  - getLabelCount
```
public int getLabelCount()
```
  - getLabels
```
public DnsLabel[] getLabels()
```
    Get a copy of the labels of this DNS name. The resulting array will contain the labels in reverse order, that is, the top-level domain will be at res[0].
    
    Returns:
    
    an array of the labels in reverse order.
  - getLabel
```
public DnsLabel getLabel(int labelNum)
```
  - getRawLabels
```
public DnsLabel[] getRawLabels()
```
    Get a copy of the raw labels of this DNS name. The resulting array will contain the labels in reverse order, that is, the top-level domain will be at res[0].
    
    Returns:
    
    an array of the raw labels in reverse order.
  - stripToLabels
```
public DnsName stripToLabels(int labelCount)
```
  - getParent
```
public DnsName getParent()
```
    Return the parent of this DNS label. Will return the root label if this label itself is the root label (because there is no parent of root).
    For example:
    
    "foo.bar.org".getParent() == "bar.org"
    
    ".".getParent() == "."
    Returns:
    
    the parent of this DNS label.
  - isRootLabel
```
public boolean isRootLabel()
```

Class DnsName

Field 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

MAX_LABELS

ROOT

IN_ADDR_ARPA

IP6_ARPA

VALIDATE

ace

Method Detail

writeToStream

getBytes

getRawBytes

getAce

getRawAce

asIdn

getDomainpart

getHostpart

getHostpartLabel

size

toString

from

from

from

from

from

from

from

from

parse

compareTo

equals

hashCode

isDirectChildOf

isChildOf

getLabelCount

getLabels

getLabel

getRawLabels

stripToLabels

getParent

isRootLabel