Package org.gnome.gio

Class InetAddressMask

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.InetAddressMask

All Implemented Interfaces:

Initable, Proxy

@Generated("io.github.jwharm.JavaGI")
public class InetAddressMask
extends GObject
implements Initable

GInetAddressMask represents a range of IPv4 or IPv6 addresses described by a base address and a length indicating how many bits of the base address are relevant for matching purposes. These are often given in string form. For example, 10.0.0.0/8, or fe80::/10.

Since:

2.32

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InetAddressMask.Builder<B extends InetAddressMask.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	InetAddressMask.InetAddressMaskClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gio.Initable

Initable.Initable$Impl, Initable.InitableIface

Constructor Summary

Constructors

Constructor	Description
InetAddressMask()	Creates a new InetAddressMask.
InetAddressMask(MemorySegment address)	Create a InetAddressMask proxy instance for the provided memory address.
InetAddressMask(InetAddress addr, int length)	Creates a new GInetAddressMask representing all addresses whose first length bits match addr.

Method Summary

Modifier and Type	Method	Description
protected InetAddressMask	asParent()	Returns this instance as if it were its parent type.
static InetAddressMask.Builder<? extends InetAddressMask.Builder>	builder()	A InetAddressMask.Builder object constructs a InetAddressMask with the specified properties.
boolean	equal(InetAddressMask mask2)	Tests if this InetAddressMask and mask2 are the same mask.
static InetAddressMask	fromString(String maskString)	Parses maskString as an IP address and (optional) length, and creates a new GInetAddressMask.
InetAddress	getAddress()	Gets mask's base address
SocketFamily	getFamily()	Gets the GSocketFamily of mask's address
int	getLength()	Gets mask's length
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the InetAddressMask class
boolean	matches(InetAddress address)	Tests if address falls within the range described by mask.
String	toString()	Converts this InetAddressMask back to its corresponding string form.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gnome.gio.Initable

init

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

InetAddressMask

public InetAddressMask(MemorySegment address)

Create a InetAddressMask proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

InetAddressMask

public InetAddressMask(InetAddress addr,
 int length)
                throws GErrorException

Creates a new GInetAddressMask representing all addresses whose first length bits match addr.

Parameters:

addr - a GInetAddress

length - number of bits of addr to use

Throws:

GErrorException - see GError

Since:

2.32

InetAddressMask

public InetAddressMask()

Creates a new InetAddressMask.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the InetAddressMask class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected InetAddressMask asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

fromString

public static InetAddressMask fromString(String maskString)
                                  throws GErrorException

Parses maskString as an IP address and (optional) length, and creates a new GInetAddressMask. The length, if present, is delimited by a "/". If it is not present, then the length is assumed to be the full length of the address.

Parameters:

maskString - an IP address or address/length string

Returns:

a new GInetAddressMask corresponding to string, or null on error.

Throws:

GErrorException - see GError

Since:

2.32

equal

public boolean equal(InetAddressMask mask2)

Tests if this InetAddressMask and mask2 are the same mask.

Parameters:

mask2 - another GInetAddressMask

Returns:

whether this InetAddressMask and mask2 are the same mask

Since:

2.32

getAddress

public InetAddress getAddress()

Gets mask's base address

Returns:

mask's base address

Since:

2.32

getFamily

public SocketFamily getFamily()

Gets the GSocketFamily of mask's address

Returns:

the GSocketFamily of mask's address

Since:

2.32

getLength

public int getLength()

Gets mask's length

Returns:

mask's length

Since:

2.32

matches

public boolean matches(InetAddress address)

Tests if address falls within the range described by mask.

Parameters:

address - a GInetAddress

Returns:

whether address falls within the range described by mask.

Since:

2.32

toString

public String toString()

Converts this InetAddressMask back to its corresponding string form.

Overrides:

toString in class Object

Returns:

a string corresponding to mask.

Since:

2.32

builder

public static InetAddressMask.Builder<? extends InetAddressMask.Builder> builder()

A InetAddressMask.Builder object constructs a InetAddressMask with the specified properties. Use the various set...() methods to set properties, and finish construction with InetAddressMask.Builder.build().

Returns:

the builder object