net.dv8tion.jda.api.entities.templates.TemplateRole Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of JDA Show documentation
Java wrapper for the popular chat & VOIP service: Discord https://discord.com
There is a newer version: 5.0.1
/*
 * Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.dv8tion.jda.api.entities.templates;

import net.dv8tion.jda.api.Permission;
import net.dv8tion.jda.api.entities.ISnowflake;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.awt.*;
import java.time.OffsetDateTime;
import java.util.EnumSet;

/**
 * POJO for the roles information provided by a template.
 *
 * @see TemplateGuild#getRoles()
 */
public class TemplateRole implements ISnowflake
{
    private final long id;
    private final String name;
    private final int color;
    private final boolean hoisted;
    private final boolean mentionable;
    private final long rawPermissions;

    public TemplateRole(final long id, final String name, final int color, final boolean hoisted, final boolean mentionable, final long rawPermissions)
    {
        this.id = id;
        this.name = name;
        this.color = color;
        this.hoisted = hoisted;
        this.mentionable = mentionable;
        this.rawPermissions = rawPermissions;
    }

    /**
     * The ids of roles are their position as stored by Discord so this will not look like a typical snowflake.
     *
     * @return The id of the role as stored by Discord
     */
    @Override
    public long getIdLong()
    {
        return this.id;
    }

    /**
     * As the ids of roles are their position, the date of creation cannot be calculated.
     *
     * @throws java.lang.UnsupportedOperationException
     *         The date of creation cannot be calculated.
     */
    @Override
    public OffsetDateTime getTimeCreated()
    {
        throw new UnsupportedOperationException("The date of creation cannot be calculated");
    }

    /**
     * The Name of this {@link TemplateRole Role}.
     *
     * @return Never-null String containing the name of this {@link TemplateRole Role}.
     */
    @Nonnull
    public String getName()
    {
        return this.name;
    }

    /**
     * The color this {@link TemplateRole Role} is displayed in.
     *
     * @return Color value of Role-color
     *
     * @see    #getColorRaw()
     */
    @Nullable
    public Color getColor()
    {
        return this.color == net.dv8tion.jda.api.entities.Role.DEFAULT_COLOR_RAW ? null : new Color(this.color);
    }

    /**
     * The raw color RGB value used for this role
     * 
Defaults to {@link net.dv8tion.jda.api.entities.Role#DEFAULT_COLOR_RAW} if this role has no set color
     *
     * @return The raw RGB color value or default
     */
    public int getColorRaw()
    {
        return this.color;
    }

    /**
     * Whether this {@link TemplateRole Role} is hoisted
     * 
Members in a hoisted role are displayed in their own grouping on the user-list
     *
     * @return True, if this {@link TemplateRole Role} is hoisted.
     */
    public boolean isHoisted()
    {
        return this.hoisted;
    }

    /**
     * Whether or not this Role is mentionable
     *
     * @return True, if Role is mentionable.
     */
    public boolean isMentionable()
    {
        return this.mentionable;
    }

    /**
     * The Guild-Wide Permissions this PermissionHolder holds.
     * 
Changes to the returned set do not affect this entity directly.
     *
     * @return An EnumSet of Permissions granted to this PermissionHolder.
     */
    @Nonnull
    public EnumSet getPermissions()
    {
        return Permission.getPermissions(rawPermissions);
    }

    /**
     * The {@code long} representation of the literal permissions that this {@link TemplateRole Role} has.
     *
     * @return Never-negative long containing offset permissions of this role.
     */
    public long getPermissionsRaw()
    {
        return rawPermissions;
    }
}