IPv6Address.IPv6Zone (IPAddress javadoc by seancfoley)

java.lang.Object
- inet.ipaddr.ipv6.IPv6Address.IPv6Zone

All Implemented Interfaces:

Serializable

Enclosing class:

IPv6Address
```
public static class IPv6Address.IPv6Zone
extends Object
implements Serializable
```
A reference to a scope id by number or a network interface by name.
An IPv6 zone distinguishes two IPv6 addresses that are the same. They are used with link-local addresses fe80::/10 to distinguish two interfaces to the link-local network, this is known as the zone id. They are used with site-local addresses to distinguish sites, using the site id, also known as the scope id.
A zone that consists of a scope id is called a scoped zone.
An IPv6 zone will reference an interface by a scoped identifier number or by interface name based on how it was constructed. If constructed with a numeric identifier, whether integer or string, it will always reference by scoped identifier. Otherwise, it will always reference by interface name.
Once constructed, it will always reference using the same method, either interface name or scope id. To reference by the other method you must use a different IPv6Zone instance.
Even though it will always reference using the same method, you can use the IPv6Zone instance to look up the scope id if the instance references by interface name, or to look up the associated interface if the instance references by scope id.

See Also:

Serialized Form

Core

Constructor Summary

Constructors
Constructor and Description
`IPv6Zone(int scopeId)` Constructs a zone that will use a scope identifier with the address.
`IPv6Zone(NetworkInterface networkInterface)` Constructs a zone that will use an interface name with the address.
`IPv6Zone(String zoneStr)` Constructs a zone that will use the given zone string, either a non-negative integer indicating a scope identifier, or the name of a network interface.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`NetworkInterface`	`getAssociatedIntf()` If this zone references a network interface, returns that interface, or null if no interface with the given name exists on the system.
`MACAddress`	`getAssociatedIntfMacAddr()` Returns the MAC address of the associated interface
`int`	`getAssociatedScopeId()` If this zone references a scoped identifier, returns that identifier.
`String`	`getName()`
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`referencesIntf()` Whether this zone references a network interface.
`boolean`	`referencesScopeId()` Whether this zone references a scope identifier.
`String`	`toString()` Returns a string representation of the object.

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

- Constructor Detail
  - IPv6Zone
```
public IPv6Zone(String zoneStr)
```
    Constructs a zone that will use the given zone string, either a non-negative integer indicating a scope identifier, or the name of a network interface.
    A scope identifier is indicated by a sequence of decimal digits.
    To create an InetAddress by pairing this zone with an IPv6Address instance, an interface name must reference an existing interface, otherwise the InetAddress cannot be created.
    See NetworkInterface to get a list of existing interfaces or to look up interfaces by name.
    
    Parameters:
    
    zoneStr -
  - IPv6Zone
```
public IPv6Zone(int scopeId)
```
    Constructs a zone that will use a scope identifier with the address.
    
    Parameters:
    
    scopeId -
  - IPv6Zone
```
public IPv6Zone(NetworkInterface networkInterface)
```
    Constructs a zone that will use an interface name with the address.
    
    Parameters:
    
    networkInterface -
- Method Detail
  - referencesIntf
```
public boolean referencesIntf()
```
    Whether this zone references a network interface.
    
    Returns:
  - referencesScopeId
```
public boolean referencesScopeId()
```
    Whether this zone references a scope identifier.
    
    Returns:
  - getAssociatedIntf
```
public NetworkInterface getAssociatedIntf()
```
    If this zone references a network interface, returns that interface, or null if no interface with the given name exists on the system. If this zone references a scope id, returns the associated interface.
    
    Returns:
  - getAssociatedIntfMacAddr
```
public MACAddress getAssociatedIntfMacAddr()
```
    Returns the MAC address of the associated interface
    
    Returns:
  - getAssociatedScopeId
```
public int getAssociatedScopeId()
```
    If this zone references a scoped identifier, returns that identifier.
    If this zone references a network interface, returns the scope identifier for the addresses of that interface, or -1 if the referenced interface cannot be found on the system, or no single scope identifier was assigned.
    
    Returns:
  - hashCode
```
public int hashCode()
```
    Description copied from class: java.lang.Object
    Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.
    The general contract of hashCode is:
    - Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
    - If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
    - It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
    As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object.
    
    See Also:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: java.lang.Object
    Indicates whether some other object is "equal to" this one.
    The equals method implements an equivalence relation on non-null object references:
    - It is reflexive: for any non-null reference value x, x.equals(x) should return true.
    - It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
    - It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
    - It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
    - For any non-null reference value x, x.equals(null) should return false.
    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
    Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - the reference object with which to compare.
    
    Returns:
    
    true if this object is the same as the obj argument; false otherwise.
    
    See Also:
    
    Object.hashCode(), HashMap
  - getName
```
public String getName()
```
  - toString
```
public String toString()
```
    Description copied from class: java.lang.Object
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.

Class IPv6Address.IPv6Zone

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IPv6Zone

IPv6Zone

IPv6Zone

Method Detail

referencesIntf

referencesScopeId

getAssociatedIntf

getAssociatedIntfMacAddr

getAssociatedScopeId

hashCode

equals

getName

toString