Package org.gnome.soup

Class Auth.Builder<B extends Auth.Builder<B>>

java.lang.Object

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

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

org.gnome.soup.Auth.Builder<B>

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface

Direct Known Subclasses:

AuthBasic.Builder, AuthDigest.Builder, AuthNegotiate.Builder, AuthNTLM.Builder

Enclosing class:

Auth

public static class Auth.Builder<B extends Auth.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
Auth	build()	Finish building the Auth object.
B	setAuthority(String authority)	The authority (host:port) being authenticated to.
B	setIsForProxy(boolean isForProxy)	Whether or not the auth is for a proxy server.
B	setRealm(String realm)	The authentication realm.

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 Auth build()
           throws UnsupportedPlatformException

Finish building the Auth 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 Auth.

Overrides:

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

Returns:

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

Throws:

UnsupportedPlatformException - when run on an unsupported platform

setAuthority

public B setAuthority(String authority)

The authority (host:port) being authenticated to.

Parameters:

authority - the value for the authority property

Returns:

the Builder instance is returned, to allow method chaining

setIsForProxy

public B setIsForProxy(boolean isForProxy)

Whether or not the auth is for a proxy server.

Parameters:

isForProxy - the value for the is-for-proxy property

Returns:

the Builder instance is returned, to allow method chaining

setRealm

public B setRealm(String realm)

The authentication realm.

Parameters:

realm - the value for the realm property

Returns:

the Builder instance is returned, to allow method chaining