Package nva.commons.core.useragent

Class UserAgent.UserAgentBuilder

java.lang.Object

nva.commons.core.useragent.UserAgent.UserAgentBuilder

Enclosing class:

UserAgent

public static final class UserAgent.UserAgentBuilder
extends Object

Allows the building of a valid UserAgent string.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NULL_VALUE_ERROR
static final String	USER_AGENT_TEMPLATE

Method Summary

Modifier and Type	Method	Description
UserAgent	build()	Builds the UserAgent.
UserAgent.UserAgentBuilder	client(Class<?> aClass)	The class that is calling, typically the Handler class that initiates the call.
UserAgent.UserAgentBuilder	email(String email)	The contact email (typically support@somewhere) that recipients can contact in case of an issue.
UserAgent.UserAgentBuilder	environment(String environment)	The environment that is calling, typically dev, test, sandbox, e2e or prod.
UserAgent.UserAgentBuilder	repository(URI uri)	The repository for the code of the calling class.
UserAgent.UserAgentBuilder	version(String version)	The version of Handler class that initiates the call.

Methods inherited from class java.lang.Object

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

Field Details

USER_AGENT_TEMPLATE

public static final String USER_AGENT_TEMPLATE

See Also:

• Constant Field Values

NULL_VALUE_ERROR

public static final String NULL_VALUE_ERROR

See Also:

• Constant Field Values

Method Details

client

public UserAgent.UserAgentBuilder client(Class<?> aClass)

The class that is calling, typically the Handler class that initiates the call.

Parameters:

aClass - The root caller class that initiates the call.

Returns:

UserAgentBuilder

version

public UserAgent.UserAgentBuilder version(String version)

The version of Handler class that initiates the call.

Parameters:

version - The version string.

Returns:

UserAgentBuilder

repository

public UserAgent.UserAgentBuilder repository(URI uri)

The repository for the code of the calling class.

Parameters:

uri - The URI of the repository.

Returns:

UserAgentBuilder

email

public UserAgent.UserAgentBuilder email(String email)

The contact email (typically support@somewhere) that recipients can contact in case of an issue.

Parameters:

email - The root caller class that initiates the call.

Returns:

UserAgentBuilder

environment

public UserAgent.UserAgentBuilder environment(String environment)

The environment that is calling, typically dev, test, sandbox, e2e or prod.

Parameters:

environment - The environment.

Returns:

UserAgentBuilder

build

public UserAgent build()

Builds the UserAgent.

Returns:

UserAgent.