Package org.gnome.webkit

Class WebsiteDataManager.Builder<B extends WebsiteDataManager.Builder<B>>

java.lang.Object

io.github.jwharm.javagi.gobject.Builder<B>

org.gnome.gobject.GObject.Builder<B>

org.gnome.webkit.WebsiteDataManager.Builder<B>

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface

Enclosing class:

WebsiteDataManager

public static class WebsiteDataManager.Builder<B extends WebsiteDataManager.Builder<B>>
extends GObject.Builder<B>

Inner class implementing a builder pattern to construct a GObject with properties.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Default constructor for a Builder object.

Method Summary

Modifier and Type	Method	Description
WebsiteDataManager	build()	Finish building the WebsiteDataManager object.
B	setBaseCacheDirectory(String baseCacheDirectory)	The base directory for caches.
B	setBaseDataDirectory(String baseDataDirectory)	The base directory for website data.
B	setIsEphemeral(boolean isEphemeral)	Whether the WebKitWebsiteDataManager is ephemeral.
B	setOriginStorageRatio(double originStorageRatio)	The percentage of volume space that can be used for data storage for every domain.
B	setTotalStorageRatio(double totalStorageRatio)	The percentage of volume space that can be used for data storage for all domains.

Methods inherited from class org.gnome.gobject.GObject.Builder

onNotify

Methods inherited from class io.github.jwharm.javagi.gobject.Builder

addBuilderProperty, connect, connect, connectSignals, getArena, getNames, getValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

protected Builder()

Default constructor for a Builder object.

Method Details

build

public WebsiteDataManager build()
                         throws UnsupportedPlatformException

Finish building the WebsiteDataManager object. This will call GObject.withProperties(org.gnome.glib.Type, java.lang.String[], org.gnome.gobject.Value[]) to create a new GObject instance, which is then cast to WebsiteDataManager.

Overrides:

build in class GObject.Builder<B extends WebsiteDataManager.Builder<B>>

Returns:

a new instance of WebsiteDataManager with the properties that were set in the Builder object.

Throws:

UnsupportedPlatformException - when run on an unsupported platform

setBaseCacheDirectory

public B setBaseCacheDirectory(String baseCacheDirectory)

The base directory for caches. If null, a default location will be used.

Parameters:

baseCacheDirectory - the value for the base-cache-directory property

Returns:

the Builder instance is returned, to allow method chaining

setBaseDataDirectory

public B setBaseDataDirectory(String baseDataDirectory)

The base directory for website data. If null, a default location will be used.

Parameters:

baseDataDirectory - the value for the base-data-directory property

Returns:

the Builder instance is returned, to allow method chaining

setIsEphemeral

public B setIsEphemeral(boolean isEphemeral)

Whether the WebKitWebsiteDataManager is ephemeral. An ephemeral WebKitWebsiteDataManager handles all websites data as non-persistent, and nothing will be written to the client storage. Note that if you create an ephemeral WebKitWebsiteDataManager all other construction parameters to configure data directories will be ignored.

Parameters:

isEphemeral - the value for the is-ephemeral property

Returns:

the Builder instance is returned, to allow method chaining

setOriginStorageRatio

public B setOriginStorageRatio(double originStorageRatio)

The percentage of volume space that can be used for data storage for every domain. If the maximum storage is reached the storage request will fail with a QuotaExceededError exception. A value of 0.0 means that data storage is not allowed. A value of -1.0, which is the default, means WebKit will use the default quota (1 GiB).

Parameters:

originStorageRatio - the value for the origin-storage-ratio property

Returns:

the Builder instance is returned, to allow method chaining

setTotalStorageRatio

public B setTotalStorageRatio(double totalStorageRatio)

The percentage of volume space that can be used for data storage for all domains. If the maximum storage is reached the eviction will happen. A value of 0.0 means that data storage is not allowed. A value of -1.0, which is the default, means there's no limit for the total storage.

Parameters:

totalStorageRatio - the value for the total-storage-ratio property

Returns:

the Builder instance is returned, to allow method chaining