net.dv8tion.jda.entities.impl

Class RoleImpl

java.lang.Object

net.dv8tion.jda.entities.impl.RoleImpl

All Implemented Interfaces:

Role

public class RoleImpl
extends java.lang.Object
implements Role

Constructor Summary

Constructors

Constructor and Description
RoleImpl(java.lang.String id, Guild guild)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	getColor() The color this Role is displayed in.
Guild	getGuild() Returns the Guild this Role exists in
java.lang.String	getId() The ID of this Role.
JDA	getJDA() Returns the JDA instance of this Role
RoleManager	getManager() Returns the RoleManager for this Role.
java.lang.String	getName() The Name of the Role.
java.util.List<Permission>	getPermissions() A list of the literal Permissions that this Role has. NOTE: these do not necessarily represent the permissions this role will have in a Channel.
int	getPermissionsRaw() The int representation of the literal permissions that this Role has. NOTE: these do not necessarily represent the permissions this role will have in a Channel.
int	getPosition() The position of this Role in the Guild hierarchy. (higher value means higher role). The @everyone Role always return -1
int	hashCode()
boolean	hasPermission(Permission perm) Checks if this Role a Guild level Permission. This does not check the Channel-specific override Permission.
boolean	isGrouped() Is this Role grouped? (Users with this Role are grouped in the online-list)
boolean	isManaged() Is this Role managed? (Via plugins like Twitch).
RoleImpl	setColor(int color)
RoleImpl	setGrouped(boolean grouped)
RoleImpl	setManaged(boolean managed)
RoleImpl	setName(java.lang.String name)
RoleImpl	setPermissions(int permissions)
RoleImpl	setPosition(int position)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleImpl

public RoleImpl(java.lang.String id,
                Guild guild)

Method Detail

getGuild

public Guild getGuild()

Description copied from interface: Role

Returns the Guild this Role exists in

Specified by:

getGuild in interface Role

Returns:

the Guild containing this Role

getJDA

public JDA getJDA()

Description copied from interface: Role

Returns the JDA instance of this Role

Specified by:

getJDA in interface Role

Returns:

the corresponding JDA instance

getId

public java.lang.String getId()

Description copied from interface: Role

The ID of this Role.

Specified by:

getId in interface Role

Returns:

Never-null String containing the id of this Role.

getPermissionsRaw

public int getPermissionsRaw()

Description copied from interface: Role

The int representation of the literal permissions that this Role has.
NOTE: these do not necessarily represent the permissions this role will have in a Channel.

Specified by:

getPermissionsRaw in interface Role

Returns:

Never-negative int containing offset permissions of this role.

getPermissions

public java.util.List<Permission> getPermissions()

Description copied from interface: Role

A list of the literal Permissions that this Role has.
NOTE: these do not necessarily represent the permissions this role will have in a Channel.

Specified by:

getPermissions in interface Role

Returns:

Possibly-empty list containing the literal permissions of this role.

getName

public java.lang.String getName()

Description copied from interface: Role

The Name of the Role.

Specified by:

getName in interface Role

Returns:

Never-null String containing the name of this Role.

getColor

public int getColor()

Description copied from interface: Role

The color this Role is displayed in.

Specified by:

getColor in interface Role

Returns:

Integer value of Role-color

getPosition

public int getPosition()

Description copied from interface: Role

The position of this Role in the Guild hierarchy.
(higher value means higher role).
The @everyone Role always return -1

Specified by:

getPosition in interface Role

Returns:

The position of this Role as integer.

hasPermission

public boolean hasPermission(Permission perm)

Description copied from interface: Role

Checks if this Role a Guild level Permission.
This does not check the Channel-specific override Permission.

Specified by:

hasPermission in interface Role

Parameters:

perm - The Permission to check for

Returns:

If the given Permission is available to this Role

isManaged

public boolean isManaged()

Description copied from interface: Role

Is this Role managed?
(Via plugins like Twitch).

Specified by:

isManaged in interface Role

Returns:

If this Role is managed.

isGrouped

public boolean isGrouped()

Description copied from interface: Role

Is this Role grouped?
(Users with this Role are grouped in the online-list)

Specified by:

isGrouped in interface Role

Returns:

If this Role is grouped.

getManager

public RoleManager getManager()

Description copied from interface: Role

Returns the RoleManager for this Role. In the RoleManager, you can modify all its values.

Specified by:

getManager in interface Role

Returns:

The RoleManager of this Role

setName

public RoleImpl setName(java.lang.String name)

setColor

public RoleImpl setColor(int color)

setPosition

public RoleImpl setPosition(int position)

setPermissions

public RoleImpl setPermissions(int permissions)

setManaged

public RoleImpl setManaged(boolean managed)

setGrouped

public RoleImpl setGrouped(boolean grouped)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object