Class DeleteSecondaryEmailResult
- java.lang.Object
-
- com.dropbox.core.v2.team.DeleteSecondaryEmailResult
-
public final class DeleteSecondaryEmailResult extends java.lang.ObjectResult 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 returntrue. You can usetag()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
OTHERvalue will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDeleteSecondaryEmailResult.TagDiscriminating tag type forDeleteSecondaryEmailResult.
-
Field Summary
Fields Modifier and Type Field Description static DeleteSecondaryEmailResultOTHERCatch-all used for unknown tag values returned by the Dropbox servers.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DeleteSecondaryEmailResultcannotRemovePrimary(java.lang.String value)Returns an instance ofDeleteSecondaryEmailResultthat has its tag set toDeleteSecondaryEmailResult.Tag.CANNOT_REMOVE_PRIMARY.booleanequals(java.lang.Object obj)java.lang.StringgetCannotRemovePrimaryValue()The email address is the primary email address of the user, and cannot be removed.java.lang.StringgetNotFoundValue()The email address was not found for the user.java.lang.StringgetSuccessValue()The secondary email was successfully deleted.inthashCode()booleanisCannotRemovePrimary()Returnstrueif this instance has the tagDeleteSecondaryEmailResult.Tag.CANNOT_REMOVE_PRIMARY,falseotherwise.booleanisNotFound()Returnstrueif this instance has the tagDeleteSecondaryEmailResult.Tag.NOT_FOUND,falseotherwise.booleanisOther()booleanisSuccess()static DeleteSecondaryEmailResultnotFound(java.lang.String value)Returns an instance ofDeleteSecondaryEmailResultthat has its tag set toDeleteSecondaryEmailResult.Tag.NOT_FOUND.static DeleteSecondaryEmailResultsuccess(java.lang.String value)Returns an instance ofDeleteSecondaryEmailResultthat has its tag set toDeleteSecondaryEmailResult.Tag.SUCCESS.DeleteSecondaryEmailResult.Tagtag()Returns the tag for this instance.java.lang.StringtoString()java.lang.StringtoStringMultiline()Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
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 Detail
-
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 returntrue. Callers are recommended to use the tag value in aswitchstatement to properly handle the different values for thisDeleteSecondaryEmailResult.If a tag returned by the server is unrecognized by this SDK, the
DeleteSecondaryEmailResult.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isSuccess
public boolean isSuccess()
- Returns:
trueif this instance is tagged asDeleteSecondaryEmailResult.Tag.SUCCESS,falseotherwise.
-
success
public static DeleteSecondaryEmailResult success(java.lang.String value)
Returns an instance ofDeleteSecondaryEmailResultthat has its tag set toDeleteSecondaryEmailResult.Tag.SUCCESS.The secondary email was successfully deleted.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
DeleteSecondaryEmailResultwith its tag set toDeleteSecondaryEmailResult.Tag.SUCCESS. - Throws:
java.lang.IllegalArgumentException- ifvalueis 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 isnull.
-
getSuccessValue
public java.lang.String getSuccessValue()
The secondary email was successfully deleted.This instance must be tagged as
DeleteSecondaryEmailResult.Tag.SUCCESS.- Returns:
- The
Stringvalue associated with this instance ifisSuccess()istrue. - Throws:
java.lang.IllegalStateException- IfisSuccess()isfalse.
-
isNotFound
public boolean isNotFound()
Returnstrueif this instance has the tagDeleteSecondaryEmailResult.Tag.NOT_FOUND,falseotherwise.- Returns:
trueif this instance is tagged asDeleteSecondaryEmailResult.Tag.NOT_FOUND,falseotherwise.
-
notFound
public static DeleteSecondaryEmailResult notFound(java.lang.String value)
Returns an instance ofDeleteSecondaryEmailResultthat has its tag set toDeleteSecondaryEmailResult.Tag.NOT_FOUND.The email address was not found for the user.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
DeleteSecondaryEmailResultwith its tag set toDeleteSecondaryEmailResult.Tag.NOT_FOUND. - Throws:
java.lang.IllegalArgumentException- ifvalueis 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 isnull.
-
getNotFoundValue
public java.lang.String getNotFoundValue()
The email address was not found for the user.This instance must be tagged as
DeleteSecondaryEmailResult.Tag.NOT_FOUND.- Returns:
- The
Stringvalue associated with this instance ifisNotFound()istrue. - Throws:
java.lang.IllegalStateException- IfisNotFound()isfalse.
-
isCannotRemovePrimary
public boolean isCannotRemovePrimary()
Returnstrueif this instance has the tagDeleteSecondaryEmailResult.Tag.CANNOT_REMOVE_PRIMARY,falseotherwise.- Returns:
trueif this instance is tagged asDeleteSecondaryEmailResult.Tag.CANNOT_REMOVE_PRIMARY,falseotherwise.
-
cannotRemovePrimary
public static DeleteSecondaryEmailResult cannotRemovePrimary(java.lang.String value)
Returns an instance ofDeleteSecondaryEmailResultthat has its tag set toDeleteSecondaryEmailResult.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
DeleteSecondaryEmailResultwith its tag set toDeleteSecondaryEmailResult.Tag.CANNOT_REMOVE_PRIMARY. - Throws:
java.lang.IllegalArgumentException- ifvalueis 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 isnull.
-
getCannotRemovePrimaryValue
public java.lang.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
Stringvalue associated with this instance ifisCannotRemovePrimary()istrue. - Throws:
java.lang.IllegalStateException- IfisCannotRemovePrimary()isfalse.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asDeleteSecondaryEmailResult.Tag.OTHER,falseotherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
toStringMultiline
public java.lang.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
-
-