Package net.dv8tion.jda.internal.entities

Class PermissionOverrideImpl

java.lang.Object

net.dv8tion.jda.internal.entities.PermissionOverrideImpl

All Implemented Interfaces:

ISnowflake, PermissionOverride

public class PermissionOverrideImpl
extends Object
implements PermissionOverride

Constructor Summary

Constructors

Constructor	Description
PermissionOverrideImpl(IPermissionContainer channel, long id, boolean isRole)

Method Summary

Modifier and Type	Method	Description
AuditableRestAction<Void>	delete()	Deletes this PermissionOverride.
boolean	equals(Object o)
EnumSet<Permission>	getAllowed()	EnumSet of all Permissions that are specifically allowed by this override.
long	getAllowedRaw()	This is the raw binary representation (as a base 10 long) of the permissions allowed by this override.
IPermissionContainerUnion	getChannel()	The GuildChannel that this PermissionOverride affects.
EnumSet<Permission>	getDenied()	EnumSet of all Permissions that are denied by this override.
long	getDeniedRaw()	This is the raw binary representation (as a base 10 long) of the permissions denied by this override.
Guild	getGuild()	The Guild that the GuildChannel returned from PermissionOverride.getChannel() is a part of.
long	getIdLong()	The Snowflake id of this entity.
EnumSet<Permission>	getInherit()	EnumSet of all Permission that are unaffected by this override.
long	getInheritRaw()	This is the raw binary representation (as a base 10 long) of the permissions not affected by this override.
JDA	getJDA()	The JDA instance that this PermissionOverride is related to.
PermissionOverrideAction	getManager()	Returns the PermissionOverrideAction to modify this PermissionOverride.
Member	getMember()	If this PermissionOverride is an override dealing with a Member, then this method will return the related Member if the member is currently cached.
IPermissionHolder	getPermissionHolder()	This method will return the PermissionHolder of this PermissionOverride.
Role	getRole()	If this PermissionOverride is an override dealing with a Role, then this method will return the related Role.
int	hashCode()
boolean	isMemberOverride()	Used to determine if this PermissionOverride relates to a specific Member.
boolean	isRoleOverride()	Used to determine if this PermissionOverride relates to a specific Role.
PermissionOverrideImpl	setAllow(long allow)
PermissionOverrideImpl	setDeny(long deny)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getTimeCreated

Constructor Details

PermissionOverrideImpl

public PermissionOverrideImpl(IPermissionContainer channel,
 long id,
 boolean isRole)

Method Details

getAllowedRaw

public long getAllowedRaw()

Description copied from interface: PermissionOverride

This is the raw binary representation (as a base 10 long) of the permissions allowed by this override.
The long relates to the offsets used by each Permission.

Specified by:

getAllowedRaw in interface PermissionOverride

Returns:

Never-negative long containing the binary representation of the allowed permissions of this override.

getInheritRaw

public long getInheritRaw()

Description copied from interface: PermissionOverride

This is the raw binary representation (as a base 10 long) of the permissions not affected by this override.
The long relates to the offsets used by each Permission.

Specified by:

getInheritRaw in interface PermissionOverride

Returns:

Never-negative long containing the binary representation of the unaffected permissions of this override.

getDeniedRaw

public long getDeniedRaw()

Description copied from interface: PermissionOverride

This is the raw binary representation (as a base 10 long) of the permissions denied by this override.
The long relates to the offsets used by each Permission.

Specified by:

getDeniedRaw in interface PermissionOverride

Returns:

Never-negative long containing the binary representation of the denied permissions of this override.

getAllowed

@Nonnull
public EnumSet<Permission> getAllowed()

Description copied from interface: PermissionOverride

EnumSet of all Permissions that are specifically allowed by this override.
Changes to the returned set do not affect this entity directly.

Specified by:

getAllowed in interface PermissionOverride

Returns:

Possibly-empty set of allowed Permissions.

getInherit

@Nonnull
public EnumSet<Permission> getInherit()

Description copied from interface: PermissionOverride

EnumSet of all Permission that are unaffected by this override.
Changes to the returned set do not affect this entity directly.

Specified by:

getInherit in interface PermissionOverride

Returns:

Possibly-empty set of unaffected Permissions.

getDenied

@Nonnull
public EnumSet<Permission> getDenied()

Description copied from interface: PermissionOverride

EnumSet of all Permissions that are denied by this override.
Changes to the returned set do not affect this entity directly.

Specified by:

getDenied in interface PermissionOverride

Returns:

Possibly-empty set of denied Permissions.

getJDA

@Nonnull
public JDA getJDA()

Description copied from interface: PermissionOverride

The JDA instance that this PermissionOverride is related to.

Specified by:

getJDA in interface PermissionOverride

Returns:

Never-null JDA instance.

getPermissionHolder

public IPermissionHolder getPermissionHolder()

Description copied from interface: PermissionOverride

This method will return the PermissionHolder of this PermissionOverride. It can be used to get the general permissions of that PermissionHolder, no matter if it is a Member or a Role.
Similar to PermissionOverride.getMember() this will return null if the member is not cached.

To get the concrete Member or Role, use PermissionOverride.getMember() or PermissionOverride.getRole()!

Specified by:

getPermissionHolder in interface PermissionOverride

Returns:

Possibly-null IPermissionHolder of this PermissionOverride.

See Also:

• PermissionOverride.getRole()
• PermissionOverride.getMember()

getMember

public Member getMember()

Description copied from interface: PermissionOverride

If this PermissionOverride is an override dealing with a Member, then this method will return the related Member if the member is currently cached.
Otherwise, this method returns null.
Basically: if PermissionOverride.isMemberOverride() returns false or the member is not cached, this returns null.

Specified by:

getMember in interface PermissionOverride

Returns:

Possibly-null related Member.

getRole

public Role getRole()

Description copied from interface: PermissionOverride

If this PermissionOverride is an override dealing with a Role, then this method will return the related Role.
Otherwise, this method returns null.
Basically: if PermissionOverride.isRoleOverride() returns false, this returns null.

Specified by:

getRole in interface PermissionOverride

Returns:

Possibly-null related Role.

getChannel

@Nonnull
public IPermissionContainerUnion getChannel()

Description copied from interface: PermissionOverride

The GuildChannel that this PermissionOverride affects.

Specified by:

getChannel in interface PermissionOverride

Returns:

Never-null related GuildChannel that this override is part of.

getGuild

@Nonnull
public Guild getGuild()

Description copied from interface: PermissionOverride

The Guild that the GuildChannel returned from PermissionOverride.getChannel() is a part of. By inference, this is the Guild that this PermissionOverride is part of.

Specified by:

getGuild in interface PermissionOverride

Returns:

Never-null related Guild.

isMemberOverride

public boolean isMemberOverride()

Description copied from interface: PermissionOverride

Used to determine if this PermissionOverride relates to a specific Member.

Specified by:

isMemberOverride in interface PermissionOverride

Returns:

True if this override is a user override.

isRoleOverride

public boolean isRoleOverride()

Description copied from interface: PermissionOverride

Used to determine if this PermissionOverride relates to a specific Role.

Specified by:

isRoleOverride in interface PermissionOverride

Returns:

True if this override is a role override.

getManager

@Nonnull
public PermissionOverrideAction getManager()

Description copied from interface: PermissionOverride

Returns the PermissionOverrideAction to modify this PermissionOverride.
In the PermissionOverrideAction you can modify the permissions of the override. You modify multiple fields in one request by chaining setters before calling RestAction.queue().

Specified by:

getManager in interface PermissionOverride

Returns:

The PermissionOverrideAction of this override.

delete

@Nonnull
public AuditableRestAction<Void> delete()

Description copied from interface: PermissionOverride

Deletes this PermissionOverride.

Possible ErrorResponses include:

• ErrorResponse.UNKNOWN_OVERRIDE
  If the the override was already deleted.
• UNKNOWN_CHANNEL
  If the channel this override was a part of was already deleted
• MISSING_ACCESS
  If we were removed from the Guild

Specified by:

delete in interface PermissionOverride

Returns:

AuditableRestAction

getIdLong

public long getIdLong()

Description copied from interface: ISnowflake

The Snowflake id of this entity. This is unique to every entity and will never change.

Specified by:

getIdLong in interface ISnowflake

Returns:

Long containing the Id.

setAllow

public PermissionOverrideImpl setAllow(long allow)

setDeny

public PermissionOverrideImpl setDeny(long deny)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object