IPAddressFormatter.Builder (ip-utils 1.3.2 API)

java.lang.Object
- com.github.robtimus.net.ip.IPAddressFormatter.Builder<IP>

Type Parameters:

IP - The supported type of IP address for built formatters.

Enclosing class:

IPAddressFormatter<IP extends IPAddress<?>>
```
public static final class IPAddressFormatter.Builder<IP extends IPAddress<?>>
extends Object
```
A builder for formatters for printing and parsing IP addresses.

Author:

Rob Spoor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IPAddressFormatter<IP>`	`build()` Returns a formatter for printing and parsing IP addresses with the current settings of this builder object.
`IPAddressFormatter.Builder<IP>`	`enclosingInBrackets()` Specifies that created formatters will enclose formatted IPv6 addresses in brackets.
`IPAddressFormatter.Builder<IP>`	`notEnclosingInBrackets()` Specifies that created formatters will not enclose formatted IPv6 addresses in brackets.
`IPAddressFormatter.Builder<IP>`	`toLowerCase()` Specifies that created formatters will format IPv6 addresses in lower case.
`IPAddressFormatter.Builder<IP>`	`toUpperCase()` Specifies that created formatters will format IPv6 addresses in upper case.
`<R> R`	`transform(Function<? super IPAddressFormatter.Builder<?>,? extends R> f)` This method allows the application of a function to this builder object.
`IPAddressFormatter.Builder<IP>`	`withDefaults()` Specifies that the default settings should be restored.
`IPAddressFormatter.Builder<IP>`	`withIPv4End()` Specifies that created formatters will format the last `4` bytes of IPv6 addresses as an IPv4 address.
`IPAddressFormatter.Builder<IP>`	`withLongStyle()` Specifies that created formatters will format IPv6 addresses in long style.
`IPAddressFormatter.Builder<IP>`	`withMediumStyle()` Specifies that created formatters will format IPv6 addresses in medium style.
`IPAddressFormatter.Builder<IP>`	`withoutIPv4End()` Specifies that created formatters will format the last `4` bytes of IPv6 addresses as two hextets, not as an IPv4 address.
`IPAddressFormatter.Builder<IP>`	`withShortStyle()` Specifies that created formatters will format IPv6 addresses in short style.

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

- Method Detail
  - withShortStyle
```
public IPAddressFormatter.Builder<IP> withShortStyle()
```
    Specifies that created formatters will format IPv6 addresses in short style. This short form will omit consecutive sections of zeroes if possible, and hextets will not contain any leading zeroes. If there are two or more consecutive sections of zeroes, the longest section will be selected. For example, ::1 will be formatted as ::1, and 0:0:1:0:0:0:0:1 will be formatted as 0:0:1::1. This setting is ignored when formatting IPv4 addresses.
    This is the default setting.
    
    Returns:
    
    This builder object.
  - withMediumStyle
```
public IPAddressFormatter.Builder<IP> withMediumStyle()
```
    Specifies that created formatters will format IPv6 addresses in medium style. This medium form will not omit consecutive sections of zeroes, but hextets will not contain any leading zeroes. For example, ::1 will be formatted as 0:0:0:0:0:0:0:1. This setting is ignored when formatting IPv4 addresses.
    
    Returns:
    
    This builder object.
  - withLongStyle
```
public IPAddressFormatter.Builder<IP> withLongStyle()
```
    Specifies that created formatters will format IPv6 addresses in long style. This long form will not omit consecutive sections of zeroes, and each hextet will be four characters long. For example, ::1 will be formatted as 0000:0000:0000:0000:0000:0000:0000:0001. This setting is ignored when formatting IPv4 addresses.
    
    Returns:
    
    This builder object.
  - toUpperCase
```
public IPAddressFormatter.Builder<IP> toUpperCase()
```
    Specifies that created formatters will format IPv6 addresses in upper case. This setting is ignored when formatting IPv4 addresses.
    
    Returns:
    
    This builder object.
  - toLowerCase
```
public IPAddressFormatter.Builder<IP> toLowerCase()
```
    Specifies that created formatters will format IPv6 addresses in lower case. This setting is ignored when formatting IPv4 addresses.
    This is the default setting.
    
    Returns:
    
    This builder object.
  - withIPv4End
```
public IPAddressFormatter.Builder<IP> withIPv4End()
```
    Specifies that created formatters will format the last 4 bytes of IPv6 addresses as an IPv4 address. For example, ::1 will be formatted as ::0.0.0.1, 0:0:0:0:0:0:0.0.0.1 or 0000:0000:0000:0000:0000:0000:0.0.0.1, depending on the style. This setting is ignored when formatting IPv4 addresses.
    
    Returns:
    
    This builder object.
  - withoutIPv4End
```
public IPAddressFormatter.Builder<IP> withoutIPv4End()
```
    Specifies that created formatters will format the last 4 bytes of IPv6 addresses as two hextets, not as an IPv4 address. This setting is ignored when formatting IPv4 addresses.
    This is the default setting.
    
    Returns:
    
    This builder object.
  - enclosingInBrackets
```
public IPAddressFormatter.Builder<IP> enclosingInBrackets()
```
    Specifies that created formatters will enclose formatted IPv6 addresses in brackets. For example, ::1 will be formatted as [::1], [0:0:0:0:0:0:0:1] or [0000:0000:0000:0000:0000:0000:0000:0001], depending on the style. This setting is ignored when formatting IPv4 addresses.
    
    Returns:
    
    This builder object.
  - notEnclosingInBrackets
```
public IPAddressFormatter.Builder<IP> notEnclosingInBrackets()
```
    Specifies that created formatters will not enclose formatted IPv6 addresses in brackets. This setting is ignored when formatting IPv4 addresses.
    This is the default setting.
    
    Returns:
    
    This builder object.
  - withDefaults
```
public IPAddressFormatter.Builder<IP> withDefaults()
```
    Specifies that the default settings should be restored. Calling this method is similar to calling withShortStyle(), toLowerCase(), withoutIPv4End() and notEnclosingInBrackets().
    
    Returns:
    
    This builder object.
  - transform
```
public <R> R transform(Function<? super IPAddressFormatter.Builder<?>,? extends R> f)
```
    This method allows the application of a function to this builder object.
    Any exception thrown by the function will be propagated to the caller.
    
    Type Parameters:
    
    R - The type of the result of the function.
    
    Parameters:
    
    f - The function to apply.
    
    Returns:
    
    The result of applying the function to this builder object.
    
    Since:
    
    1.3
  - build
```
public IPAddressFormatter<IP> build()
```
    Returns a formatter for printing and parsing IP addresses with the current settings of this builder object.
    
    Returns:
    
    A formatter for printing and parsing IP addresses with the current settings of this builder object.

Class IPAddressFormatter.Builder<IP extends IPAddress<?>>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

withShortStyle

withMediumStyle

withLongStyle

toUpperCase

toLowerCase

withIPv4End

withoutIPv4End

enclosingInBrackets

notEnclosingInBrackets

withDefaults

transform

build