Package com.dropbox.core.v2.team

Class DeleteSecondaryEmailResult

java.lang.Object

com.dropbox.core.v2.team.DeleteSecondaryEmailResult

public final class DeleteSecondaryEmailResult
extends Object

Result of trying to delete a secondary email address. 'success' is the only value indicating that a secondary email was successfully deleted. The other values explain the type of error that occurred, and include the email for which the error occurred.

This class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isAbc() methods will return true. You can use tag() to determine the tag associated with this instance.

Open unions may be extended in the future with additional tags. If a new tag is introduced that this SDK does not recognized, the OTHER value will be used.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DeleteSecondaryEmailResult.Tag	Discriminating tag type for DeleteSecondaryEmailResult.

Field Summary

Fields

Modifier and Type	Field	Description
static final DeleteSecondaryEmailResult	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
static DeleteSecondaryEmailResult	cannotRemovePrimary(String value)	Returns an instance of DeleteSecondaryEmailResult that has its tag set to DeleteSecondaryEmailResult.Tag.CANNOT_REMOVE_PRIMARY.
boolean	equals(Object obj)
String	getCannotRemovePrimaryValue()	The email address is the primary email address of the user, and cannot be removed.
String	getNotFoundValue()	The email address was not found for the user.
String	getSuccessValue()	The secondary email was successfully deleted.
int	hashCode()
boolean	isCannotRemovePrimary()	Returns true if this instance has the tag DeleteSecondaryEmailResult.Tag.CANNOT_REMOVE_PRIMARY, false otherwise.
boolean	isNotFound()	Returns true if this instance has the tag DeleteSecondaryEmailResult.Tag.NOT_FOUND, false otherwise.
boolean	isOther()	Returns true if this instance has the tag DeleteSecondaryEmailResult.Tag.OTHER, false otherwise.
boolean	isSuccess()	Returns true if this instance has the tag DeleteSecondaryEmailResult.Tag.SUCCESS, false otherwise.
static DeleteSecondaryEmailResult	notFound(String value)	Returns an instance of DeleteSecondaryEmailResult that has its tag set to DeleteSecondaryEmailResult.Tag.NOT_FOUND.
static DeleteSecondaryEmailResult	success(String value)	Returns an instance of DeleteSecondaryEmailResult that has its tag set to DeleteSecondaryEmailResult.Tag.SUCCESS.
DeleteSecondaryEmailResult.Tag	tag()	Returns the tag for this instance.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

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

Field Details

OTHER

public static final DeleteSecondaryEmailResult OTHER

Catch-all used for unknown tag values returned by the Dropbox servers.

Receiving a catch-all value typically indicates this SDK version is not up to date. Consider updating your SDK version to handle the new tags.

Method Details

tag

public DeleteSecondaryEmailResult.Tag tag()

Returns the tag for this instance.

This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isXyz() methods will return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this DeleteSecondaryEmailResult.

If a tag returned by the server is unrecognized by this SDK, the DeleteSecondaryEmailResult.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isSuccess

public boolean isSuccess()

Returns true if this instance has the tag DeleteSecondaryEmailResult.Tag.SUCCESS, false otherwise.

Returns:

true if this instance is tagged as DeleteSecondaryEmailResult.Tag.SUCCESS, false otherwise.

success

public static DeleteSecondaryEmailResult success(String value)

Returns an instance of DeleteSecondaryEmailResult that has its tag set to DeleteSecondaryEmailResult.Tag.SUCCESS.

The secondary email was successfully deleted.

Parameters:

value - value to assign to this instance.

Returns:

Instance of DeleteSecondaryEmailResult with its tag set to DeleteSecondaryEmailResult.Tag.SUCCESS.

Throws:

IllegalArgumentException - if value is longer than 255, does not match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", or is null.

getSuccessValue

public String getSuccessValue()

The secondary email was successfully deleted.

This instance must be tagged as DeleteSecondaryEmailResult.Tag.SUCCESS.

Returns:

The String value associated with this instance if isSuccess() is true.

Throws:

IllegalStateException - If isSuccess() is false.

isNotFound

public boolean isNotFound()

Returns true if this instance has the tag DeleteSecondaryEmailResult.Tag.NOT_FOUND, false otherwise.

Returns:

true if this instance is tagged as DeleteSecondaryEmailResult.Tag.NOT_FOUND, false otherwise.

notFound

public static DeleteSecondaryEmailResult notFound(String value)

Returns an instance of DeleteSecondaryEmailResult that has its tag set to DeleteSecondaryEmailResult.Tag.NOT_FOUND.

The email address was not found for the user.

Parameters:

value - value to assign to this instance.

Returns:

Instance of DeleteSecondaryEmailResult with its tag set to DeleteSecondaryEmailResult.Tag.NOT_FOUND.

Throws:

IllegalArgumentException - if value is longer than 255, does not match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", or is null.

getNotFoundValue

public String getNotFoundValue()

The email address was not found for the user.

This instance must be tagged as DeleteSecondaryEmailResult.Tag.NOT_FOUND.

Returns:

The String value associated with this instance if isNotFound() is true.

Throws:

IllegalStateException - If isNotFound() is false.

isCannotRemovePrimary

public boolean isCannotRemovePrimary()

Returns true if this instance has the tag DeleteSecondaryEmailResult.Tag.CANNOT_REMOVE_PRIMARY, false otherwise.

Returns:

true if this instance is tagged as DeleteSecondaryEmailResult.Tag.CANNOT_REMOVE_PRIMARY, false otherwise.

cannotRemovePrimary

public static DeleteSecondaryEmailResult cannotRemovePrimary(String value)

Returns an instance of DeleteSecondaryEmailResult that has its tag set to DeleteSecondaryEmailResult.Tag.CANNOT_REMOVE_PRIMARY.

The email address is the primary email address of the user, and cannot be removed.

Parameters:

value - value to assign to this instance.

Returns:

Instance of DeleteSecondaryEmailResult with its tag set to DeleteSecondaryEmailResult.Tag.CANNOT_REMOVE_PRIMARY.

Throws:

IllegalArgumentException - if value is longer than 255, does not match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", or is null.

getCannotRemovePrimaryValue

public String getCannotRemovePrimaryValue()

The email address is the primary email address of the user, and cannot be removed.

This instance must be tagged as DeleteSecondaryEmailResult.Tag.CANNOT_REMOVE_PRIMARY.

Returns:

The String value associated with this instance if isCannotRemovePrimary() is true.

Throws:

IllegalStateException - If isCannotRemovePrimary() is false.

isOther

public boolean isOther()

Returns true if this instance has the tag DeleteSecondaryEmailResult.Tag.OTHER, false otherwise.

Returns:

true if this instance is tagged as DeleteSecondaryEmailResult.Tag.OTHER, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public String toStringMultiline()

Returns a String representation of this object formatted for easier readability.

The returned String may contain newlines.

Returns:

Formatted, multiline String representation of this object