Package com.isode.dsapi.profile

Class IDValue

java.lang.Object

com.isode.dsapi.profile.IDValue

public class IDValue
extends Object

Class for managing a unique id value

Since:

17.0

Author:

ac

Constructor Summary

Constructors

Constructor	Description
IDValue()	Constructor for IDValue with unset.
IDValue(String value)	Creates a IDValue with the given id value.

Method Summary

Modifier and Type	Method	Description
String	getIDAndGenerate()	Gets the id if it is set, if it is not set generates one and then returns it.
Optional<String>	getIDIfSet()	Gets the id if it is set.
boolean	idEquals(String value)	Indicates if the ID value is equal to the given value.
boolean	isIDSet()	Indicates if an id value is set.

Methods inherited from class java.lang.Object

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

Constructor Details

IDValue

public IDValue()

Constructor for IDValue with unset.

IDValue

public IDValue(String value)

Creates a IDValue with the given id value.

Parameters:

value - The id value to set, if null the IDValue will be created with no id

Method Details

getIDIfSet

public Optional<String> getIDIfSet()

Gets the id if it is set.

Returns:

An Optional containing the id if it is set, otherwise an empty Optional

getIDAndGenerate

public String getIDAndGenerate()

Gets the id if it is set, if it is not set generates one and then returns it.

Returns:

The set id, or a newly generated id if it was not set.

isIDSet

public boolean isIDSet()

Indicates if an id value is set.

Returns:

true if an id value is set.

idEquals

public boolean idEquals(String value)

Indicates if the ID value is equal to the given value.

Parameters:

value - A value to check against, if null value will be false.

Returns:

true if id is set and equals the given value, otherwise false