Package com.dropbox.core.v2.teamlog

Class ParticipantLogInfo

java.lang.Object

com.dropbox.core.v2.teamlog.ParticipantLogInfo

public final class ParticipantLogInfo
extends Object

A user or group

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	ParticipantLogInfo.Tag	Discriminating tag type for ParticipantLogInfo.

Field Summary

Fields

Modifier and Type	Field	Description
static final ParticipantLogInfo	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
GroupLogInfo	getGroupValue()	Group details.
UserLogInfo	getUserValue()	A user with a Dropbox account.
static ParticipantLogInfo	group(GroupLogInfo value)	Returns an instance of ParticipantLogInfo that has its tag set to ParticipantLogInfo.Tag.GROUP.
int	hashCode()
boolean	isGroup()	Returns true if this instance has the tag ParticipantLogInfo.Tag.GROUP, false otherwise.
boolean	isOther()	Returns true if this instance has the tag ParticipantLogInfo.Tag.OTHER, false otherwise.
boolean	isUser()	Returns true if this instance has the tag ParticipantLogInfo.Tag.USER, false otherwise.
ParticipantLogInfo.Tag	tag()	Returns the tag for this instance.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.
static ParticipantLogInfo	user(UserLogInfo value)	Returns an instance of ParticipantLogInfo that has its tag set to ParticipantLogInfo.Tag.USER.

Methods inherited from class java.lang.Object

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

Field Details

OTHER

public static final ParticipantLogInfo 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 ParticipantLogInfo.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 ParticipantLogInfo.

If a tag returned by the server is unrecognized by this SDK, the ParticipantLogInfo.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isGroup

public boolean isGroup()

Returns true if this instance has the tag ParticipantLogInfo.Tag.GROUP, false otherwise.

Returns:

true if this instance is tagged as ParticipantLogInfo.Tag.GROUP, false otherwise.

group

public static ParticipantLogInfo group(GroupLogInfo value)

Returns an instance of ParticipantLogInfo that has its tag set to ParticipantLogInfo.Tag.GROUP.

Group details.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ParticipantLogInfo with its tag set to ParticipantLogInfo.Tag.GROUP.

Throws:

IllegalArgumentException - if value is null.

getGroupValue

public GroupLogInfo getGroupValue()

Group details.

This instance must be tagged as ParticipantLogInfo.Tag.GROUP.

Returns:

The GroupLogInfo value associated with this instance if isGroup() is true.

Throws:

IllegalStateException - If isGroup() is false.

isUser

public boolean isUser()

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

Returns:

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

user

public static ParticipantLogInfo user(UserLogInfo value)

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

A user with a Dropbox account.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getUserValue

public UserLogInfo getUserValue()

A user with a Dropbox account.

This instance must be tagged as ParticipantLogInfo.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 ParticipantLogInfo.Tag.OTHER, false otherwise.

Returns:

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