com.contrastsecurity.sdk

Class UserAgentProduct

java.lang.Object

com.contrastsecurity.sdk.UserAgentProduct

public final class UserAgentProduct
extends java.lang.Object

Value object that describes a product in a user-agent string.

Method Summary

Modifier and Type	Method and Description
java.lang.String	comment()
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	name()
static UserAgentProduct	of(java.lang.String name)
static UserAgentProduct	of(java.lang.String name, java.lang.String version)
static UserAgentProduct	of(java.lang.String name, java.lang.String version, java.lang.String comment)
java.lang.String	toEncodedString()
java.lang.String	toString()
java.lang.String	version()

Methods inherited from class java.lang.Object

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

Method Detail

of

public static UserAgentProduct of(java.lang.String name)

Parameters:

name - product name

Returns:

new UserAgentProduct

Throws:

java.lang.NullPointerException - when name is null

of

public static UserAgentProduct of(java.lang.String name,
                                  java.lang.String version)

Parameters:

name - product name

version - product version

Returns:

new UserAgentProduct

Throws:

java.lang.NullPointerException - when name is null

of

public static UserAgentProduct of(java.lang.String name,
                                  java.lang.String version,
                                  java.lang.String comment)

Parameters:

name - product name

version - product version

comment - comment

Returns:

new UserAgentProduct

Throws:

java.lang.NullPointerException - when name is null

name

public java.lang.String name()

Returns:

user-agent product name

version

public java.lang.String version()

Returns:

user-agent product version, or null if not set

comment

public java.lang.String comment()

Returns:

user-agent product comment, or null if not set

toEncodedString

public java.lang.String toEncodedString()

Returns:

user-agent encoded string i.e. "name/version (comment)"

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object