Class ActorLogInfo
- java.lang.Object
-
- com.dropbox.core.v2.teamlog.ActorLogInfo
-
public final class ActorLogInfo extends java.lang.ObjectThe entity who performed the action.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 classActorLogInfo.TagDiscriminating tag type forActorLogInfo.
-
Field Summary
Fields Modifier and Type Field Description static ActorLogInfoANONYMOUSAnonymous actor.static ActorLogInfoDROPBOXAction done by Dropbox.static ActorLogInfoOTHERCatch-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 ActorLogInfoadmin(UserLogInfo value)Returns an instance ofActorLogInfothat has its tag set toActorLogInfo.Tag.ADMIN.static ActorLogInfoapp(AppLogInfo value)Returns an instance ofActorLogInfothat has its tag set toActorLogInfo.Tag.APP.booleanequals(java.lang.Object obj)UserLogInfogetAdminValue()The admin who did the action.AppLogInfogetAppValue()The application who did the action.ResellerLogInfogetResellerValue()Action done by reseller.UserLogInfogetUserValue()The user who did the action.inthashCode()booleanisAdmin()booleanisAnonymous()booleanisApp()booleanisDropbox()booleanisOther()booleanisReseller()booleanisUser()static ActorLogInforeseller(ResellerLogInfo value)Returns an instance ofActorLogInfothat has its tag set toActorLogInfo.Tag.RESELLER.ActorLogInfo.Tagtag()Returns the tag for this instance.java.lang.StringtoString()java.lang.StringtoStringMultiline()Returns a String representation of this object formatted for easier readability.static ActorLogInfouser(UserLogInfo value)Returns an instance ofActorLogInfothat has its tag set toActorLogInfo.Tag.USER.
-
-
-
Field Detail
-
ANONYMOUS
public static final ActorLogInfo ANONYMOUS
Anonymous actor.
-
DROPBOX
public static final ActorLogInfo DROPBOX
Action done by Dropbox.
-
OTHER
public static final ActorLogInfo 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 ActorLogInfo.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 thisActorLogInfo.If a tag returned by the server is unrecognized by this SDK, the
ActorLogInfo.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isAdmin
public boolean isAdmin()
- Returns:
trueif this instance is tagged asActorLogInfo.Tag.ADMIN,falseotherwise.
-
admin
public static ActorLogInfo admin(UserLogInfo value)
Returns an instance ofActorLogInfothat has its tag set toActorLogInfo.Tag.ADMIN.The admin who did the action.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
ActorLogInfowith its tag set toActorLogInfo.Tag.ADMIN. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getAdminValue
public UserLogInfo getAdminValue()
The admin who did the action.This instance must be tagged as
ActorLogInfo.Tag.ADMIN.- Returns:
- The
UserLogInfovalue associated with this instance ifisAdmin()istrue. - Throws:
java.lang.IllegalStateException- IfisAdmin()isfalse.
-
isAnonymous
public boolean isAnonymous()
- Returns:
trueif this instance is tagged asActorLogInfo.Tag.ANONYMOUS,falseotherwise.
-
isApp
public boolean isApp()
- Returns:
trueif this instance is tagged asActorLogInfo.Tag.APP,falseotherwise.
-
app
public static ActorLogInfo app(AppLogInfo value)
Returns an instance ofActorLogInfothat has its tag set toActorLogInfo.Tag.APP.The application who did the action.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
ActorLogInfowith its tag set toActorLogInfo.Tag.APP. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getAppValue
public AppLogInfo getAppValue()
The application who did the action.This instance must be tagged as
ActorLogInfo.Tag.APP.- Returns:
- The
AppLogInfovalue associated with this instance ifisApp()istrue. - Throws:
java.lang.IllegalStateException- IfisApp()isfalse.
-
isDropbox
public boolean isDropbox()
- Returns:
trueif this instance is tagged asActorLogInfo.Tag.DROPBOX,falseotherwise.
-
isReseller
public boolean isReseller()
- Returns:
trueif this instance is tagged asActorLogInfo.Tag.RESELLER,falseotherwise.
-
reseller
public static ActorLogInfo reseller(ResellerLogInfo value)
Returns an instance ofActorLogInfothat has its tag set toActorLogInfo.Tag.RESELLER.Action done by reseller.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
ActorLogInfowith its tag set toActorLogInfo.Tag.RESELLER. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getResellerValue
public ResellerLogInfo getResellerValue()
Action done by reseller.This instance must be tagged as
ActorLogInfo.Tag.RESELLER.- Returns:
- The
ResellerLogInfovalue associated with this instance ifisReseller()istrue. - Throws:
java.lang.IllegalStateException- IfisReseller()isfalse.
-
isUser
public boolean isUser()
- Returns:
trueif this instance is tagged asActorLogInfo.Tag.USER,falseotherwise.
-
user
public static ActorLogInfo user(UserLogInfo value)
Returns an instance ofActorLogInfothat has its tag set toActorLogInfo.Tag.USER.The user who did the action.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
ActorLogInfowith its tag set toActorLogInfo.Tag.USER. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getUserValue
public UserLogInfo getUserValue()
The user who did the action.This instance must be tagged as
ActorLogInfo.Tag.USER.- Returns:
- The
UserLogInfovalue associated with this instance ifisUser()istrue. - Throws:
java.lang.IllegalStateException- IfisUser()isfalse.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asActorLogInfo.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
-
-