Class ActorLogInfo
- java.lang.Object
-
- com.dropbox.core.v2.teamlog.ActorLogInfo
-
public final class ActorLogInfo extends java.lang.Object
The 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
OTHER
value will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ActorLogInfo.Tag
Discriminating tag type forActorLogInfo
.
-
Field Summary
Fields Modifier and Type Field Description static ActorLogInfo
ANONYMOUS
Anonymous actor.static ActorLogInfo
DROPBOX
Action done by Dropbox.static ActorLogInfo
OTHER
Catch-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 ActorLogInfo
admin(UserLogInfo value)
Returns an instance ofActorLogInfo
that has its tag set toActorLogInfo.Tag.ADMIN
.static ActorLogInfo
app(AppLogInfo value)
Returns an instance ofActorLogInfo
that has its tag set toActorLogInfo.Tag.APP
.boolean
equals(java.lang.Object obj)
UserLogInfo
getAdminValue()
The admin who did the action.AppLogInfo
getAppValue()
The application who did the action.ResellerLogInfo
getResellerValue()
Action done by reseller.UserLogInfo
getUserValue()
The user who did the action.int
hashCode()
boolean
isAdmin()
boolean
isAnonymous()
boolean
isApp()
boolean
isDropbox()
boolean
isOther()
boolean
isReseller()
boolean
isUser()
static ActorLogInfo
reseller(ResellerLogInfo value)
Returns an instance ofActorLogInfo
that has its tag set toActorLogInfo.Tag.RESELLER
.ActorLogInfo.Tag
tag()
Returns the tag for this instance.java.lang.String
toString()
java.lang.String
toStringMultiline()
Returns a String representation of this object formatted for easier readability.static ActorLogInfo
user(UserLogInfo value)
Returns an instance ofActorLogInfo
that 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 aswitch
statement to properly handle the different values for thisActorLogInfo
.If a tag returned by the server is unrecognized by this SDK, the
ActorLogInfo.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isAdmin
public boolean isAdmin()
- Returns:
true
if this instance is tagged asActorLogInfo.Tag.ADMIN
,false
otherwise.
-
admin
public static ActorLogInfo admin(UserLogInfo value)
Returns an instance ofActorLogInfo
that has its tag set toActorLogInfo.Tag.ADMIN
.The admin who did the action.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
ActorLogInfo
with its tag set toActorLogInfo.Tag.ADMIN
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getAdminValue
public UserLogInfo getAdminValue()
The admin who did the action.This instance must be tagged as
ActorLogInfo.Tag.ADMIN
.- Returns:
- The
UserLogInfo
value associated with this instance ifisAdmin()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisAdmin()
isfalse
.
-
isAnonymous
public boolean isAnonymous()
- Returns:
true
if this instance is tagged asActorLogInfo.Tag.ANONYMOUS
,false
otherwise.
-
isApp
public boolean isApp()
- Returns:
true
if this instance is tagged asActorLogInfo.Tag.APP
,false
otherwise.
-
app
public static ActorLogInfo app(AppLogInfo value)
Returns an instance ofActorLogInfo
that has its tag set toActorLogInfo.Tag.APP
.The application who did the action.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
ActorLogInfo
with its tag set toActorLogInfo.Tag.APP
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getAppValue
public AppLogInfo getAppValue()
The application who did the action.This instance must be tagged as
ActorLogInfo.Tag.APP
.- Returns:
- The
AppLogInfo
value associated with this instance ifisApp()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisApp()
isfalse
.
-
isDropbox
public boolean isDropbox()
- Returns:
true
if this instance is tagged asActorLogInfo.Tag.DROPBOX
,false
otherwise.
-
isReseller
public boolean isReseller()
- Returns:
true
if this instance is tagged asActorLogInfo.Tag.RESELLER
,false
otherwise.
-
reseller
public static ActorLogInfo reseller(ResellerLogInfo value)
Returns an instance ofActorLogInfo
that has its tag set toActorLogInfo.Tag.RESELLER
.Action done by reseller.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
ActorLogInfo
with its tag set toActorLogInfo.Tag.RESELLER
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getResellerValue
public ResellerLogInfo getResellerValue()
Action done by reseller.This instance must be tagged as
ActorLogInfo.Tag.RESELLER
.- Returns:
- The
ResellerLogInfo
value associated with this instance ifisReseller()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisReseller()
isfalse
.
-
isUser
public boolean isUser()
- Returns:
true
if this instance is tagged asActorLogInfo.Tag.USER
,false
otherwise.
-
user
public static ActorLogInfo user(UserLogInfo value)
Returns an instance ofActorLogInfo
that has its tag set toActorLogInfo.Tag.USER
.The user who did the action.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
ActorLogInfo
with its tag set toActorLogInfo.Tag.USER
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getUserValue
public UserLogInfo getUserValue()
The user who did the action.This instance must be tagged as
ActorLogInfo.Tag.USER
.- Returns:
- The
UserLogInfo
value associated with this instance ifisUser()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisUser()
isfalse
.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asActorLogInfo.Tag.OTHER
,false
otherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in 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
-
-