Package com.dropbox.core.v2.teamlog

Class ContextLogInfo

java.lang.Object

com.dropbox.core.v2.teamlog.ContextLogInfo

public final class ContextLogInfo
extends Object

The primary entity on which the action was done.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextLogInfo	ANONYMOUS	Anonymous context.
static final ContextLogInfo	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final ContextLogInfo	TEAM	Action was done on behalf of the team.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
NonTeamMemberLogInfo	getNonTeamMemberValue()	Action was done on behalf of a non team member.
TeamLogInfo	getOrganizationTeamValue()	Action was done on behalf of a team that's part of an organization.
TeamMemberLogInfo	getTeamMemberValue()	Action was done on behalf of a team member.
TrustedNonTeamMemberLogInfo	getTrustedNonTeamMemberValue()	Action was done on behalf of a trusted non team member.
int	hashCode()
boolean	isAnonymous()	Returns true if this instance has the tag ContextLogInfo.Tag.ANONYMOUS, false otherwise.
boolean	isNonTeamMember()	Returns true if this instance has the tag ContextLogInfo.Tag.NON_TEAM_MEMBER, false otherwise.
boolean	isOrganizationTeam()	Returns true if this instance has the tag ContextLogInfo.Tag.ORGANIZATION_TEAM, false otherwise.
boolean	isOther()	Returns true if this instance has the tag ContextLogInfo.Tag.OTHER, false otherwise.
boolean	isTeam()	Returns true if this instance has the tag ContextLogInfo.Tag.TEAM, false otherwise.
boolean	isTeamMember()	Returns true if this instance has the tag ContextLogInfo.Tag.TEAM_MEMBER, false otherwise.
boolean	isTrustedNonTeamMember()	Returns true if this instance has the tag ContextLogInfo.Tag.TRUSTED_NON_TEAM_MEMBER, false otherwise.
static ContextLogInfo	nonTeamMember(NonTeamMemberLogInfo value)	Returns an instance of ContextLogInfo that has its tag set to ContextLogInfo.Tag.NON_TEAM_MEMBER.
static ContextLogInfo	organizationTeam(TeamLogInfo value)	Returns an instance of ContextLogInfo that has its tag set to ContextLogInfo.Tag.ORGANIZATION_TEAM.
ContextLogInfo.Tag	tag()	Returns the tag for this instance.
static ContextLogInfo	teamMember(TeamMemberLogInfo value)	Returns an instance of ContextLogInfo that has its tag set to ContextLogInfo.Tag.TEAM_MEMBER.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.
static ContextLogInfo	trustedNonTeamMember(TrustedNonTeamMemberLogInfo value)	Returns an instance of ContextLogInfo that has its tag set to ContextLogInfo.Tag.TRUSTED_NON_TEAM_MEMBER.

Methods inherited from class java.lang.Object

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

Field Details

ANONYMOUS

public static final ContextLogInfo ANONYMOUS

Anonymous context.

TEAM

public static final ContextLogInfo TEAM

Action was done on behalf of the team.

OTHER

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

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

Returns:

the tag for this instance.

isAnonymous

public boolean isAnonymous()

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

Returns:

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

isNonTeamMember

public boolean isNonTeamMember()

Returns true if this instance has the tag ContextLogInfo.Tag.NON_TEAM_MEMBER, false otherwise.

Returns:

true if this instance is tagged as ContextLogInfo.Tag.NON_TEAM_MEMBER, false otherwise.

nonTeamMember

public static ContextLogInfo nonTeamMember(NonTeamMemberLogInfo value)

Returns an instance of ContextLogInfo that has its tag set to ContextLogInfo.Tag.NON_TEAM_MEMBER.

Action was done on behalf of a non team member.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ContextLogInfo with its tag set to ContextLogInfo.Tag.NON_TEAM_MEMBER.

Throws:

IllegalArgumentException - if value is null.

getNonTeamMemberValue

public NonTeamMemberLogInfo getNonTeamMemberValue()

Action was done on behalf of a non team member.

This instance must be tagged as ContextLogInfo.Tag.NON_TEAM_MEMBER.

Returns:

The NonTeamMemberLogInfo value associated with this instance if isNonTeamMember() is true.

Throws:

IllegalStateException - If isNonTeamMember() is false.

isOrganizationTeam

public boolean isOrganizationTeam()

Returns true if this instance has the tag ContextLogInfo.Tag.ORGANIZATION_TEAM, false otherwise.

Returns:

true if this instance is tagged as ContextLogInfo.Tag.ORGANIZATION_TEAM, false otherwise.

organizationTeam

public static ContextLogInfo organizationTeam(TeamLogInfo value)

Returns an instance of ContextLogInfo that has its tag set to ContextLogInfo.Tag.ORGANIZATION_TEAM.

Action was done on behalf of a team that's part of an organization.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ContextLogInfo with its tag set to ContextLogInfo.Tag.ORGANIZATION_TEAM.

Throws:

IllegalArgumentException - if value is null.

getOrganizationTeamValue

public TeamLogInfo getOrganizationTeamValue()

Action was done on behalf of a team that's part of an organization.

This instance must be tagged as ContextLogInfo.Tag.ORGANIZATION_TEAM.

Returns:

The TeamLogInfo value associated with this instance if isOrganizationTeam() is true.

Throws:

IllegalStateException - If isOrganizationTeam() is false.

isTeam

public boolean isTeam()

Returns true if this instance has the tag ContextLogInfo.Tag.TEAM, false otherwise.

Returns:

true if this instance is tagged as ContextLogInfo.Tag.TEAM, false otherwise.

isTeamMember

public boolean isTeamMember()

Returns true if this instance has the tag ContextLogInfo.Tag.TEAM_MEMBER, false otherwise.

Returns:

true if this instance is tagged as ContextLogInfo.Tag.TEAM_MEMBER, false otherwise.

teamMember

public static ContextLogInfo teamMember(TeamMemberLogInfo value)

Returns an instance of ContextLogInfo that has its tag set to ContextLogInfo.Tag.TEAM_MEMBER.

Action was done on behalf of a team member.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ContextLogInfo with its tag set to ContextLogInfo.Tag.TEAM_MEMBER.

Throws:

IllegalArgumentException - if value is null.

getTeamMemberValue

public TeamMemberLogInfo getTeamMemberValue()

Action was done on behalf of a team member.

This instance must be tagged as ContextLogInfo.Tag.TEAM_MEMBER.

Returns:

The TeamMemberLogInfo value associated with this instance if isTeamMember() is true.

Throws:

IllegalStateException - If isTeamMember() is false.

isTrustedNonTeamMember

public boolean isTrustedNonTeamMember()

Returns true if this instance has the tag ContextLogInfo.Tag.TRUSTED_NON_TEAM_MEMBER, false otherwise.

Returns:

true if this instance is tagged as ContextLogInfo.Tag.TRUSTED_NON_TEAM_MEMBER, false otherwise.

trustedNonTeamMember

public static ContextLogInfo trustedNonTeamMember(TrustedNonTeamMemberLogInfo value)

Returns an instance of ContextLogInfo that has its tag set to ContextLogInfo.Tag.TRUSTED_NON_TEAM_MEMBER.

Action was done on behalf of a trusted non team member.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ContextLogInfo with its tag set to ContextLogInfo.Tag.TRUSTED_NON_TEAM_MEMBER.

Throws:

IllegalArgumentException - if value is null.

getTrustedNonTeamMemberValue

public TrustedNonTeamMemberLogInfo getTrustedNonTeamMemberValue()

Action was done on behalf of a trusted non team member.

This instance must be tagged as ContextLogInfo.Tag.TRUSTED_NON_TEAM_MEMBER.

Returns:

The TrustedNonTeamMemberLogInfo value associated with this instance if isTrustedNonTeamMember() is true.

Throws:

IllegalStateException - If isTrustedNonTeamMember() is false.

isOther

public boolean isOther()

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

Returns:

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