net.dv8tion.jda.api.requests.restaction.order.RoleOrderAction Maven / Gradle / Ivy

Go to download

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.1.0

/*
 * 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.requests.restaction.order;

import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.Role;

import javax.annotation.Nonnull;

/**
 * Implementation of {@link OrderAction OrderAction}
 * designed to modify the order of {@link net.dv8tion.jda.api.entities.Role Roles} of the
 * specified {@link net.dv8tion.jda.api.entities.Guild Guild}.
 * 
To apply the changes you must finish the {@link net.dv8tion.jda.api.requests.RestAction RestAction}
 *
 * Before you can use any of the {@code move} methods
 * you must use either {@link #selectPosition(Object) selectPosition(Role)} or {@link #selectPosition(int)}!
 *
 * This uses descending order!
 *
 * @since 3.0
 *
 * @see   net.dv8tion.jda.api.entities.Guild#modifyRolePositions()
 * @see   net.dv8tion.jda.api.entities.Guild#modifyRolePositions(boolean)
 */
public interface RoleOrderAction extends OrderAction
{
    /**
     * The {@link net.dv8tion.jda.api.entities.Guild Guild} which holds
     * the roles from {@link #getCurrentOrder()}
     *
     * @return The corresponding {@link net.dv8tion.jda.api.entities.Guild Guild}
     */
    @Nonnull
    Guild getGuild();
}