Class SharedFolderMemberError
- java.lang.Object
-
- com.dropbox.core.v2.sharing.SharedFolderMemberError
-
public final class SharedFolderMemberError extends java.lang.ObjectThis class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of theisAbc()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 classSharedFolderMemberError.TagDiscriminating tag type forSharedFolderMemberError.
-
Field Summary
Fields Modifier and Type Field Description static SharedFolderMemberErrorINVALID_DROPBOX_IDThe target dropbox_id is invalid.static SharedFolderMemberErrorNOT_A_MEMBERThe target dropbox_id is not a member of the shared folder.static SharedFolderMemberErrorOTHERCatch-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 booleanequals(java.lang.Object obj)MemberAccessLevelResultgetNoExplicitAccessValue()The target member only has inherited access to the shared folder.inthashCode()booleanisInvalidDropboxId()Returnstrueif this instance has the tagSharedFolderMemberError.Tag.INVALID_DROPBOX_ID,falseotherwise.booleanisNoExplicitAccess()Returnstrueif this instance has the tagSharedFolderMemberError.Tag.NO_EXPLICIT_ACCESS,falseotherwise.booleanisNotAMember()Returnstrueif this instance has the tagSharedFolderMemberError.Tag.NOT_A_MEMBER,falseotherwise.booleanisOther()static SharedFolderMemberErrornoExplicitAccess(MemberAccessLevelResult value)Returns an instance ofSharedFolderMemberErrorthat has its tag set toSharedFolderMemberError.Tag.NO_EXPLICIT_ACCESS.SharedFolderMemberError.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
-
INVALID_DROPBOX_ID
public static final SharedFolderMemberError INVALID_DROPBOX_ID
The target dropbox_id is invalid.
-
NOT_A_MEMBER
public static final SharedFolderMemberError NOT_A_MEMBER
The target dropbox_id is not a member of the shared folder.
-
OTHER
public static final SharedFolderMemberError 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 SharedFolderMemberError.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 thisSharedFolderMemberError.If a tag returned by the server is unrecognized by this SDK, the
SharedFolderMemberError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isInvalidDropboxId
public boolean isInvalidDropboxId()
Returnstrueif this instance has the tagSharedFolderMemberError.Tag.INVALID_DROPBOX_ID,falseotherwise.- Returns:
trueif this instance is tagged asSharedFolderMemberError.Tag.INVALID_DROPBOX_ID,falseotherwise.
-
isNotAMember
public boolean isNotAMember()
Returnstrueif this instance has the tagSharedFolderMemberError.Tag.NOT_A_MEMBER,falseotherwise.- Returns:
trueif this instance is tagged asSharedFolderMemberError.Tag.NOT_A_MEMBER,falseotherwise.
-
isNoExplicitAccess
public boolean isNoExplicitAccess()
Returnstrueif this instance has the tagSharedFolderMemberError.Tag.NO_EXPLICIT_ACCESS,falseotherwise.- Returns:
trueif this instance is tagged asSharedFolderMemberError.Tag.NO_EXPLICIT_ACCESS,falseotherwise.
-
noExplicitAccess
public static SharedFolderMemberError noExplicitAccess(MemberAccessLevelResult value)
Returns an instance ofSharedFolderMemberErrorthat has its tag set toSharedFolderMemberError.Tag.NO_EXPLICIT_ACCESS.The target member only has inherited access to the shared folder.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
SharedFolderMemberErrorwith its tag set toSharedFolderMemberError.Tag.NO_EXPLICIT_ACCESS. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getNoExplicitAccessValue
public MemberAccessLevelResult getNoExplicitAccessValue()
The target member only has inherited access to the shared folder.This instance must be tagged as
SharedFolderMemberError.Tag.NO_EXPLICIT_ACCESS.- Returns:
- The
MemberAccessLevelResultvalue associated with this instance ifisNoExplicitAccess()istrue. - Throws:
java.lang.IllegalStateException- IfisNoExplicitAccess()isfalse.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asSharedFolderMemberError.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
-
-