Package com.dropbox.core.v2.teamlog

Class ActorLogInfo

java.lang.Object

com.dropbox.core.v2.teamlog.ActorLogInfo

public final class ActorLogInfo
extends 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 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	ActorLogInfo.Tag	Discriminating tag type for ActorLogInfo.

Field Summary

Fields

Modifier and Type	Field	Description
static final ActorLogInfo	ANONYMOUS	Anonymous actor.
static final ActorLogInfo	DROPBOX	Action done by Dropbox.
static final ActorLogInfo	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
static ActorLogInfo	admin(UserLogInfo value)	Returns an instance of ActorLogInfo that has its tag set to ActorLogInfo.Tag.ADMIN.
static ActorLogInfo	app(AppLogInfo value)	Returns an instance of ActorLogInfo that has its tag set to ActorLogInfo.Tag.APP.
boolean	equals(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()	Returns true if this instance has the tag ActorLogInfo.Tag.ADMIN, false otherwise.
boolean	isAnonymous()	Returns true if this instance has the tag ActorLogInfo.Tag.ANONYMOUS, false otherwise.
boolean	isApp()	Returns true if this instance has the tag ActorLogInfo.Tag.APP, false otherwise.
boolean	isDropbox()	Returns true if this instance has the tag ActorLogInfo.Tag.DROPBOX, false otherwise.
boolean	isOther()	Returns true if this instance has the tag ActorLogInfo.Tag.OTHER, false otherwise.
boolean	isReseller()	Returns true if this instance has the tag ActorLogInfo.Tag.RESELLER, false otherwise.
boolean	isUser()	Returns true if this instance has the tag ActorLogInfo.Tag.USER, false otherwise.
static ActorLogInfo	reseller(ResellerLogInfo value)	Returns an instance of ActorLogInfo that has its tag set to ActorLogInfo.Tag.RESELLER.
ActorLogInfo.Tag	tag()	Returns the tag for this instance.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.
static ActorLogInfo	user(UserLogInfo value)	Returns an instance of ActorLogInfo that has its tag set to ActorLogInfo.Tag.USER.

Methods inherited from class java.lang.Object

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

Field Details

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 Details

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 return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this ActorLogInfo.

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 has the tag ActorLogInfo.Tag.ADMIN, false otherwise.

Returns:

true if this instance is tagged as ActorLogInfo.Tag.ADMIN, false otherwise.

admin

public static ActorLogInfo admin(UserLogInfo value)

Returns an instance of ActorLogInfo that has its tag set to ActorLogInfo.Tag.ADMIN.

The admin who did the action.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ActorLogInfo with its tag set to ActorLogInfo.Tag.ADMIN.

Throws:

IllegalArgumentException - if value is null.

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 if isAdmin() is true.

Throws:

IllegalStateException - If isAdmin() is false.

isAnonymous

public boolean isAnonymous()

Returns true if this instance has the tag ActorLogInfo.Tag.ANONYMOUS, false otherwise.

Returns:

true if this instance is tagged as ActorLogInfo.Tag.ANONYMOUS, false otherwise.

isApp

public boolean isApp()

Returns true if this instance has the tag ActorLogInfo.Tag.APP, false otherwise.

Returns:

true if this instance is tagged as ActorLogInfo.Tag.APP, false otherwise.

app

public static ActorLogInfo app(AppLogInfo value)

Returns an instance of ActorLogInfo that has its tag set to ActorLogInfo.Tag.APP.

The application who did the action.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ActorLogInfo with its tag set to ActorLogInfo.Tag.APP.

Throws:

IllegalArgumentException - if value is null.

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 if isApp() is true.

Throws:

IllegalStateException - If isApp() is false.

isDropbox

public boolean isDropbox()

Returns true if this instance has the tag ActorLogInfo.Tag.DROPBOX, false otherwise.

Returns:

true if this instance is tagged as ActorLogInfo.Tag.DROPBOX, false otherwise.

isReseller

public boolean isReseller()

Returns true if this instance has the tag ActorLogInfo.Tag.RESELLER, false otherwise.

Returns:

true if this instance is tagged as ActorLogInfo.Tag.RESELLER, false otherwise.

reseller

public static ActorLogInfo reseller(ResellerLogInfo value)

Returns an instance of ActorLogInfo that has its tag set to ActorLogInfo.Tag.RESELLER.

Action done by reseller.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ActorLogInfo with its tag set to ActorLogInfo.Tag.RESELLER.

Throws:

IllegalArgumentException - if value is null.

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 if isReseller() is true.

Throws:

IllegalStateException - If isReseller() is false.

isUser

public boolean isUser()

Returns true if this instance has the tag ActorLogInfo.Tag.USER, false otherwise.

Returns:

true if this instance is tagged as ActorLogInfo.Tag.USER, false otherwise.

user

public static ActorLogInfo user(UserLogInfo value)

Returns an instance of ActorLogInfo that has its tag set to ActorLogInfo.Tag.USER.

The user who did the action.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ActorLogInfo with its tag set to ActorLogInfo.Tag.USER.

Throws:

IllegalArgumentException - if value is null.

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 if isUser() is true.

Throws:

IllegalStateException - If isUser() is false.

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as ActorLogInfo.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